Skip to content

Masking API (5.1.42)

Schema for the Continuous Compliance Engine API

Download OpenAPI description
CC Engine APIs (2025.2.0.0).json
CC Engine APIs (2025.2.0.0).yaml
Languages
Servers
Mock server
https://help-api.delphix.com/_mock/continuous-compliance-engine/2025.2.0.0/cc-engine-apis-2025.2.0.0
https://help-api.delphix.com/masking/api/v5.1.42

algorithm

Operations

logging

Operations

application

Operations

applicationSettings

Operations

asyncTask

Operations

billingUsage

Operations

classifier

Operations

columnMetadata

Operations

credentialPath

Operations

configuration

Operations

databaseConnector

Operations

databaseRuleset

Operations

domain

Operations

encryptionKey

Operations

environment

Operations

execution

Operations

executionComponent

Operations

executionEvent

Operations

sync

Operations

fileConnector

Operations

fileDownload

Operations

fileFieldMetadata

Operations

fileFormat

Operations

fileMetadata

Operations

fileRuleset

Operations

fileUpload

Operations

inventoryApproval

Operations

knowledgeBaseInfo

Operations

jdbcDriver

Operations

license

Operations

Get all licenses

Request

Security
api_key
Query
jdbc_driver_idinteger(int32)

The JDBC driver Id to get the license

page_numberinteger(int64)

The page number for which to get licences. This will default to the first page if excluded

Default 1
page_sizeinteger(int64)

The maximum number of objects to return. This will default to the DefaultApiPageSize setting property if not provided

curl -i -X GET \
  'https://help-api.delphix.com/_mock/continuous-compliance-engine/2025.2.0.0/cc-engine-apis-2025.2.0.0/license?jdbc_driver_id=0&page_number=1&page_size=0' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Success

Bodyapplication/json
_pageInfoobject(PageInfo)
responseListArray of objects(License)
Example: [{"licenseId":"3","licenseFileName":"license.bin","licenseType":"JDBC_DRIVER","jdbcDriverId":"1","createdTime":"2023-03-15T12:16:35.964Z"}]
Response
application/json
{
  "_pageInfo": {
    "numberOnPage": 0,
    "total": 0
  },
  "responseList": [
    { … }
  ]
}

Create license

Request

WARNING: The generated curl command is incorrect, so please refer to the Masking API guide for instructions on how to upload files through the API

Security
api_key
Bodymultipart/form-datarequired
licenseFilestring(binary)required

The license file to be uploaded. The logical name of the license will be exactly the name of this uploaded file

licenseTypestringrequired

The type of the license file being uploaded

Value"JDBC_DRIVER"
jdbcDriverIdinteger(int32)required

The ID number of the JDBC driver.

curl -i -X POST \
  https://help-api.delphix.com/_mock/continuous-compliance-engine/2025.2.0.0/cc-engine-apis-2025.2.0.0/license \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: multipart/form-data' \
  -F licenseFile=string \
  -F licenseType=JDBC_DRIVER \
  -F jdbcDriverId=0

Responses

Success

Bodyapplication/json
licenseIdinteger(int32)read-only

The ID number of the license. This field is auto-generated by the Masking Engine.

Example: "3"
licenseFileNamestring<= 100 charactersread-only

The name of the license, as inferred from the uploaded file.

Example: "license.bin"
licenseTypestringread-only

The type of file that this license describes.

Value"JDBC_DRIVER"
Example: "JDBC_DRIVER"
jdbcDriverIdinteger(int32)read-only

The ID number of the JDBC driver.

Example: "1"
createdTimestring(date-time)read-only

The time when the license was added. This field is auto-generated by the Masking Engine.

Example: "2023-03-15T12:16:35.964Z"
Response
application/json
{
  "licenseId": "3",
  "licenseFileName": "license.bin",
  "licenseType": "JDBC_DRIVER",
  "jdbcDriverId": "1",
  "createdTime": "2023-03-15T12:16:35.964Z"
}

Get license by ID

Request

Security
api_key
Path
licenseIdinteger(int32)required

The ID of the license to get

curl -i -X GET \
  'https://help-api.delphix.com/_mock/continuous-compliance-engine/2025.2.0.0/cc-engine-apis-2025.2.0.0/license/{licenseId}' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Success

Bodyapplication/json
licenseIdinteger(int32)read-only

The ID number of the license. This field is auto-generated by the Masking Engine.

Example: "3"
licenseFileNamestring<= 100 charactersread-only

The name of the license, as inferred from the uploaded file.

Example: "license.bin"
licenseTypestringread-only

The type of file that this license describes.

Value"JDBC_DRIVER"
Example: "JDBC_DRIVER"
jdbcDriverIdinteger(int32)read-only

The ID number of the JDBC driver.

Example: "1"
createdTimestring(date-time)read-only

The time when the license was added. This field is auto-generated by the Masking Engine.

Example: "2023-03-15T12:16:35.964Z"
Response
application/json
{
  "licenseId": "3",
  "licenseFileName": "license.bin",
  "licenseType": "JDBC_DRIVER",
  "jdbcDriverId": "1",
  "createdTime": "2023-03-15T12:16:35.964Z"
}

Delete license by ID

Request

Security
api_key
Path
licenseIdinteger(int32)required

The ID of the license to delete

curl -i -X DELETE \
  'https://help-api.delphix.com/_mock/continuous-compliance-engine/2025.2.0.0/cc-engine-apis-2025.2.0.0/license/{licenseId}' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Success

login

Operations

mainframeDatasetConnector

Operations

mainframeDatasetFieldMetadata

Operations

mainframeDatasetFormat

Operations

mainframeDatasetMetadata

Operations

mainframeDatasetRecordType

Operations

mainframeDatasetRuleset

Operations

mappingAlgorithm

Operations

maskingJob

Operations

monitoring

Operations

mountFilesystem

Operations

nonConformantDataSample

Operations

passwordVault

Operations

plugin

Operations

profileJob

Operations

profileSet

Operations

profileResultDatabase

Operations

profileResultFile

Operations

profileResultMainframe

Operations

recordType

Operations

recordTypeQualifier

Operations

reidentificationJob

Operations

role

Operations

sshKey

Operations

supportBundle

Operations

systemInformation

Operations

tableMetadata

Operations

tokenizationJob

Operations

user

Operations