Skip to content

Masking API (5.1.43)

Schema for the Continuous Compliance Engine API

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

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

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

Get all plugins

Request

Get a detailed list of all installed plugins

Security
api_key
Query
page_numberinteger(int64)

The page number for which to get algorithm plugins. 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 if not provided

pluginTypestring

The type of plugin to retrieve.

Default "EXTENDED_ALGORITHM"
Enum"EXTENDED_ALGORITHM""DRIVER_SUPPORT"
curl -i -X GET \
  'https://help-api.delphix.com/_mock/continuous-compliance-engine/2025.3.0.0/cc-engine-apis-2025.3.0.0/plugin?page_number=1&page_size=0&pluginType=EXTENDED_ALGORITHM' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Success

Bodyapplication/json
_pageInfoobject(PageInfo)
responseListArray of objects(Plugin)
Example: [{"pluginId":1,"pluginName":"myPlugin","originalFileName":"algorithm.jar","jarFingerprint":"dce2599f5ece9441a4b84194313245b65618490a47cead870c3327738decd052","installDate":"2019-09-19T19:43:09.762+0000","installUser":5,"builtIn":false,"pluginVersion":"1.0.0-RELEASE","algorithmNames":["myAlgorithm1","myAlgorithm2"]}]
Response
application/json
{
  "_pageInfo": {
    "numberOnPage": 0,
    "total": 0
  },
  "responseList": [
    { … }
  ]
}

Install plugin

Request

Install an uploaded plugin file onto the system

Security
api_key
Query
fileReferenceIdstringrequired

The file references ID of the uploaded plugin JAR file to install

pluginNamestring

Override the default name of the plugin. Plugin names must be unique across plugins of the same type on the engine.

pluginTypestring

The type of plugin to retrieve.

Default "EXTENDED_ALGORITHM"
Enum"EXTENDED_ALGORITHM""DRIVER_SUPPORT"
curl -i -X POST \
  'https://help-api.delphix.com/_mock/continuous-compliance-engine/2025.3.0.0/cc-engine-apis-2025.3.0.0/plugin?fileReferenceId=string&pluginName=string&pluginType=EXTENDED_ALGORITHM' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Success

Bodyapplication/json
pluginIdinteger(int64)read-only

The id of the plugin

Example: 1
pluginNamestringread-only

The name of the plugin

Example: "myPlugin"
pluginAuthorstringread-only

The author of the plugin

pluginTypestringread-only

The type of plugin

Enum"EXTENDED_ALGORITHM""DRIVER_SUPPORT"
originalFileNamestringread-only

The original name of the plugin JAR file

Example: "algorithm.jar"
originalFileChecksumstringread-only

The hex string value of the SHA-256 hash of the plugin JAR file

installDatestring(date-time)read-only

Date and time when this plugin was installed

Example: "2019-09-19T19:43:09.762+0000"
installUserinteger(int32)read-only

The login ID of the user that installed this plugin

Example: 5
builtInbooleanread-only

Whether this plugin was included with Delphix Engine software distribution

pluginVersionstringread-only

The string version identifier of the plugin

Example: "1.0.0-RELEASE"
descriptionstringread-only

The description of the plugin

pluginObjectsArray of objects(PluginObject)

List of objects included in the plugin

Response
application/json
{
  "pluginId": 1,
  "pluginName": "myPlugin",
  "pluginAuthor": "pluginAuthor",
  "pluginType": "EXTENDED_ALGORITHM",
  "originalFileName": "algorithm.jar",
  "jarFingerprint": "dce2599f5ece9441a4b84194313245b65618490a47cead870c3327738decd052",
  "installDate": "2019-09-19T19:43:09.762+0000",
  "installUser": 5,
  "builtIn": false,
  "pluginVersion": "1.0.0-RELEASE",
  "algorithmNames": [
    "myAlgorithm1",
    "myAlgorithm2"
  ]
}

Get plugin detail by pluginId

Request

Get detailed information about an installed plugin by pluginId

Security
api_key
Path
pluginIdinteger(int64)required

The ID of the plugin to get

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

Responses

Success

Bodyapplication/json
pluginIdinteger(int64)read-only

The id of the plugin

Example: 1
pluginNamestringread-only

The name of the plugin

Example: "myPlugin"
pluginAuthorstringread-only

The author of the plugin

pluginTypestringread-only

The type of plugin

Enum"EXTENDED_ALGORITHM""DRIVER_SUPPORT"
originalFileNamestringread-only

The original name of the plugin JAR file

Example: "algorithm.jar"
originalFileChecksumstringread-only

The hex string value of the SHA-256 hash of the plugin JAR file

installDatestring(date-time)read-only

Date and time when this plugin was installed

Example: "2019-09-19T19:43:09.762+0000"
installUserinteger(int32)read-only

The login ID of the user that installed this plugin

Example: 5
builtInbooleanread-only

Whether this plugin was included with Delphix Engine software distribution

pluginVersionstringread-only

The string version identifier of the plugin

Example: "1.0.0-RELEASE"
descriptionstringread-only

The description of the plugin

pluginObjectsArray of objects(PluginObject)

List of objects included in the plugin

Response
application/json
{
  "pluginId": 1,
  "pluginName": "myPlugin",
  "pluginAuthor": "pluginAuthor",
  "pluginType": "EXTENDED_ALGORITHM",
  "originalFileName": "algorithm.jar",
  "jarFingerprint": "dce2599f5ece9441a4b84194313245b65618490a47cead870c3327738decd052",
  "installDate": "2019-09-19T19:43:09.762+0000",
  "installUser": 5,
  "builtIn": false,
  "pluginVersion": "1.0.0-RELEASE",
  "algorithmNames": [
    "myAlgorithm1",
    "myAlgorithm2"
  ]
}

Update plugin

Request

Update an installed plugin to use the uploaded JAR file. The new plugin must contain all components delivered by the previous version.

Security
api_key
Path
pluginIdinteger(int64)required

The ID of the plugin to update

Query
fileReferenceIdstringrequired

The file references ID of the new uploaded plugin JAR file

pluginNamestring

The name of the plugin

curl -i -X PUT \
  'https://help-api.delphix.com/_mock/continuous-compliance-engine/2025.3.0.0/cc-engine-apis-2025.3.0.0/plugin/{pluginId}?fileReferenceId=string&pluginName=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Success

Bodyapplication/json
pluginIdinteger(int64)read-only

The id of the plugin

Example: 1
pluginNamestringread-only

The name of the plugin

Example: "myPlugin"
pluginAuthorstringread-only

The author of the plugin

pluginTypestringread-only

The type of plugin

Enum"EXTENDED_ALGORITHM""DRIVER_SUPPORT"
originalFileNamestringread-only

The original name of the plugin JAR file

Example: "algorithm.jar"
originalFileChecksumstringread-only

The hex string value of the SHA-256 hash of the plugin JAR file

installDatestring(date-time)read-only

Date and time when this plugin was installed

Example: "2019-09-19T19:43:09.762+0000"
installUserinteger(int32)read-only

The login ID of the user that installed this plugin

Example: 5
builtInbooleanread-only

Whether this plugin was included with Delphix Engine software distribution

pluginVersionstringread-only

The string version identifier of the plugin

Example: "1.0.0-RELEASE"
descriptionstringread-only

The description of the plugin

pluginObjectsArray of objects(PluginObject)

List of objects included in the plugin

Response
application/json
{
  "pluginId": 1,
  "pluginName": "myPlugin",
  "pluginAuthor": "pluginAuthor",
  "pluginType": "EXTENDED_ALGORITHM",
  "originalFileName": "algorithm.jar",
  "jarFingerprint": "dce2599f5ece9441a4b84194313245b65618490a47cead870c3327738decd052",
  "installDate": "2019-09-19T19:43:09.762+0000",
  "installUser": 5,
  "builtIn": false,
  "pluginVersion": "1.0.0-RELEASE",
  "algorithmNames": [
    "myAlgorithm1",
    "myAlgorithm2"
  ]
}

Delete plugin

Request

Delete an installed plugin.

Security
api_key
Path
pluginIdinteger(int64)required

The ID of the plugin to delete

Query
forceboolean

Force deletion of all dependent usage associated with the plugin, such as inventory and domain assignments of algorithms

Default false
curl -i -X DELETE \
  'https://help-api.delphix.com/_mock/continuous-compliance-engine/2025.3.0.0/cc-engine-apis-2025.3.0.0/plugin/{pluginId}?force=false' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Success

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