Update ALL usage on the engine of the chosen algorithm to the replacement algorithm

algorithm

Operations

Get all algorithms

Request

Security

api_key

Query

mask_typestring

The data type of value this algorithm can mask.

Enum"BIG_DECIMAL""LOCAL_DATE_TIME""STRING""BYTE_BUFFER""GENERIC_DATA_ROW"

page_numberinteger(int64)

The page number for which to get algorithms. 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

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

Responses

Success

Bodyapplication/json

_pageInfoobject(PageInfo)

responseListArray of objects(Algorithm)

Example: [{"algorithmName":"SimpleMaskingAlgorithm","algorithmType":"COMPONENT","description":"This is a simple algorithm that serves as an example for the API. The frameworkId value may vary by engine.","pluginId":7,"frameworkId":3,"algorithmExtension":{"lookupFile":{"uri":"delphix-file://upload/f_a0c6c02dac4a4303a26ea5418fb72d5b/example.txt"}}}]

Response

application/json

{
  "_pageInfo": {
    "numberOnPage": 0,
    "total": 0
  },
  "responseList": [
    { … }
  ]
}

Create algorithm

Request

Security

api_key

Bodyapplication/jsonrequired

The algorithm to create

algorithmNamestring<= 201 charactersrequired

Equivalent to the algorithm name saved by the user through the GUI. For out of the box algo, this represents algorithm code.

Example: "SimpleMaskingAlgorithm"

algorithmTypestringrequired

The type of algorithm

Default "COMPONENT"

Enum"BINARY_LOOKUP""CLEANSING""COMPONENT""CUSTOM_ALGORITHM""DATE""LOOKUP""MAPPING""MINMAX""MISC""REDACTION"

Example: "COMPONENT"

descriptionstring

The description of the algorithm

Example: "This is a simple algorithm that serves as an example for the API. The frameworkId value may vary by engine."

frameworkIdinteger(int64)

The algorithm framework id

Example: 3

fieldsArray of objects(AlgorithmField)

algorithmExtensionobject

Example: {"lookupFile":{"uri":"delphix-file://upload/f_a0c6c02dac4a4303a26ea5418fb72d5b/example.txt"}}

curl -i -X POST \
  https://help-api.delphix.com/_mock/continuous-compliance-engine/2025.3.0.0/cc-engine-apis-2025.3.0.0/algorithms \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "algorithmName": "SimpleMaskingAlgorithm",
    "algorithmType": "COMPONENT",
    "description": "This is a simple algorithm that serves as an example for the API. The frameworkId value may vary by engine.",
    "pluginId": 7,
    "frameworkId": 3,
    "algorithmExtension": {
      "lookupFile": {
        "uri": "delphix-file://upload/f_a0c6c02dac4a4303a26ea5418fb72d5b/example.txt"
      }
    }
  }'

Responses

Success

Bodyapplication/json

asyncTaskIdinteger(int32)read-only

The ID of the AsyncTask. This field will be generated by the Masking Engine.

Example: 1

operationstringread-only

The type of operation that the AsyncTask is performing.

Enum"ADD_MAPPINGS""ALGORITHM_CREATE""ALGORITHM_MIGRATE""ALGORITHM_UPDATE""DATAFILE_BULK_UPDATE""ENCRYPTION_KEY_CREATE""EXPORT""EXPORT_CLASSIFIER_FILES""EXPORT_MAPPINGS""EXPORT_PROFILE_SET"

Example: "RULESET_REFRESH"

referencestring<= 255 charactersread-only

The reference for the AsyncTask. An example of a reference is the ruleset ID for a RULESET_REFRESH operation.

Example: 13

statusstringread-only

The status of the AsyncTask in regard to its completion.

Enum"CANCELLED""FAILED""RUNNING""SUCCEEDED""WAITING"

Example: "RUNNING"

startTimestring(date-time)read-only

The date and time that this AsyncTask was started.

endTimestring(date-time)read-only

The date and time that this AsyncTask completed.

cancellablebooleanread-only

True if the AsyncTask can be cancelled, false otherwise.

exceptionDetailstringread-only

The details associated with the Java exception that caused this async task to fail, if applicable.

Response

application/json

{
  "asyncTaskId": 1,
  "operation": "RULESET_REFRESH",
  "reference": 13,
  "status": "RUNNING",
  "cancellable": false
}

Get algorithm by name

Request

Security

api_key

Path

algorithmNamestringrequired

The name of the algorithm 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/algorithms/{algorithmName}' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Success

Bodyapplication/json

algorithmNamestring<= 201 charactersrequired

Equivalent to the algorithm name saved by the user through the GUI. For out of the box algo, this represents algorithm code.

Example: "SimpleMaskingAlgorithm"

legacyNamestring<= 201 charactersread-only

This represents algorithm name shown on the UI.

algorithmTypestringrequired

The type of algorithm

Default "COMPONENT"

Enum"BINARY_LOOKUP""CLEANSING""COMPONENT""CUSTOM_ALGORITHM""DATE""LOOKUP""MAPPING""MINMAX""MISC""REDACTION"

Example: "COMPONENT"

createdBystring<= 255 charactersread-only

The name of the user that created the algorithm

descriptionstring

The description of the algorithm

Example: "This is a simple algorithm that serves as an example for the API. The frameworkId value may vary by engine."

maskTypestringread-only

The masking type of the algorithm

isTokenizationSupportedbooleanread-only

Whether or not the algorithm can be used with tokenization and reidentification job

frameworkIdinteger(int64)

The algorithm framework id

Example: 3

frameworkNamestringread-only

The algorithm framework name

jsonConfigurablebooleanread-only

The algorithm is json Configurable or not.

pluginIdinteger(int64)read-only

The id, if applicable, of the plugin that supplies this algorithm or the framework this algorithm is built on

Example: 7

fieldsArray of objects(AlgorithmField)

algorithmExtensionobject

Example: {"lookupFile":{"uri":"delphix-file://upload/f_a0c6c02dac4a4303a26ea5418fb72d5b/example.txt"}}

isConfigInvalidbooleanread-only

Whether or not the configuration in algorithmExtension is invalid

Response

application/json

{
  "algorithmName": "SimpleMaskingAlgorithm",
  "algorithmType": "COMPONENT",
  "description": "This is a simple algorithm that serves as an example for the API. The frameworkId value may vary by engine.",
  "pluginId": 7,
  "frameworkId": 3,
  "algorithmExtension": {
    "lookupFile": { … }
  }
}

Update algorithm by name

Request

Security

api_key

Path

algorithmNamestringrequired

The name of the algorithm to update

Bodyapplication/jsonrequired

The updated algorithm

algorithmNamestring<= 201 charactersrequired

Equivalent to the algorithm name saved by the user through the GUI. For out of the box algo, this represents algorithm code.

Example: "SimpleMaskingAlgorithm"

algorithmTypestringrequired

The type of algorithm

Default "COMPONENT"

Enum"BINARY_LOOKUP""CLEANSING""COMPONENT""CUSTOM_ALGORITHM""DATE""LOOKUP""MAPPING""MINMAX""MISC""REDACTION"

Example: "COMPONENT"

descriptionstring

The description of the algorithm

Example: "This is a simple algorithm that serves as an example for the API. The frameworkId value may vary by engine."

frameworkIdinteger(int64)

The algorithm framework id

Example: 3

fieldsArray of objects(AlgorithmField)

algorithmExtensionobject

Example: {"lookupFile":{"uri":"delphix-file://upload/f_a0c6c02dac4a4303a26ea5418fb72d5b/example.txt"}}

curl -i -X PUT \
  'https://help-api.delphix.com/_mock/continuous-compliance-engine/2025.3.0.0/cc-engine-apis-2025.3.0.0/algorithms/{algorithmName}' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "algorithmName": "SimpleMaskingAlgorithm",
    "algorithmType": "COMPONENT",
    "description": "This is a simple algorithm that serves as an example for the API. The frameworkId value may vary by engine.",
    "pluginId": 7,
    "frameworkId": 3,
    "algorithmExtension": {
      "lookupFile": {
        "uri": "delphix-file://upload/f_a0c6c02dac4a4303a26ea5418fb72d5b/example.txt"
      }
    }
  }'

Responses

Success

Bodyapplication/json

asyncTaskIdinteger(int32)read-only

The ID of the AsyncTask. This field will be generated by the Masking Engine.

Example: 1

operationstringread-only

The type of operation that the AsyncTask is performing.

Enum"ADD_MAPPINGS""ALGORITHM_CREATE""ALGORITHM_MIGRATE""ALGORITHM_UPDATE""DATAFILE_BULK_UPDATE""ENCRYPTION_KEY_CREATE""EXPORT""EXPORT_CLASSIFIER_FILES""EXPORT_MAPPINGS""EXPORT_PROFILE_SET"

Example: "RULESET_REFRESH"

referencestring<= 255 charactersread-only

The reference for the AsyncTask. An example of a reference is the ruleset ID for a RULESET_REFRESH operation.

Example: 13

statusstringread-only

The status of the AsyncTask in regard to its completion.

Enum"CANCELLED""FAILED""RUNNING""SUCCEEDED""WAITING"

Example: "RUNNING"

startTimestring(date-time)read-only

The date and time that this AsyncTask was started.

endTimestring(date-time)read-only

The date and time that this AsyncTask completed.

cancellablebooleanread-only

True if the AsyncTask can be cancelled, false otherwise.

exceptionDetailstringread-only

The details associated with the Java exception that caused this async task to fail, if applicable.

Response

application/json

{
  "asyncTaskId": 1,
  "operation": "RULESET_REFRESH",
  "reference": 13,
  "status": "RUNNING",
  "cancellable": false
}

Delete algorithm by name

Request

Security

api_key

Path

algorithmNamestringrequired

The name of the algorithm to delete

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

Responses

Success

Get a list of all algorithms that support migration to a new framework

Request

Security

api_key

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

Responses

Success

Bodyapplication/json

availableMigrationsArray of objects(AlgorithmMigration)

Example: [{"algorithmName":"My Mapping Algorithm","frameworkId":7}]

Response

application/json

{
  "availableMigrations": [
    { … }
  ]
}

Create a migrated copy of an existing legacy algorithm

Request

Security

api_key

Path

algorithmNamestringrequired

The name of the algorithm to be migrated.

Query

newAlgorithmNamestringrequired

The name of the new algorithm to be created by the migration process.

curl -i -X POST \
  'https://help-api.delphix.com/_mock/continuous-compliance-engine/2025.3.0.0/cc-engine-apis-2025.3.0.0/algorithms/{algorithmName}/migration?newAlgorithmName=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Success

Bodyapplication/json

asyncTaskIdinteger(int32)read-only

The ID of the AsyncTask. This field will be generated by the Masking Engine.

Example: 1

operationstringread-only

The type of operation that the AsyncTask is performing.

Enum"ADD_MAPPINGS""ALGORITHM_CREATE""ALGORITHM_MIGRATE""ALGORITHM_UPDATE""DATAFILE_BULK_UPDATE""ENCRYPTION_KEY_CREATE""EXPORT""EXPORT_CLASSIFIER_FILES""EXPORT_MAPPINGS""EXPORT_PROFILE_SET"

Example: "RULESET_REFRESH"

referencestring<= 255 charactersread-only

The reference for the AsyncTask. An example of a reference is the ruleset ID for a RULESET_REFRESH operation.

Example: 13

statusstringread-only

The status of the AsyncTask in regard to its completion.

Enum"CANCELLED""FAILED""RUNNING""SUCCEEDED""WAITING"

Example: "RUNNING"

startTimestring(date-time)read-only

The date and time that this AsyncTask was started.

endTimestring(date-time)read-only

The date and time that this AsyncTask completed.

cancellablebooleanread-only

True if the AsyncTask can be cancelled, false otherwise.

exceptionDetailstringread-only

The details associated with the Java exception that caused this async task to fail, if applicable.

Response

application/json

{
  "asyncTaskId": 1,
  "operation": "RULESET_REFRESH",
  "reference": 13,
  "status": "RUNNING",
  "cancellable": false
}

Randomize algorithm key by name

Request

Security

api_key

Path

algorithmNamestringrequired

The name of the algorithm who's key should be randomized

curl -i -X PUT \
  'https://help-api.delphix.com/_mock/continuous-compliance-engine/2025.3.0.0/cc-engine-apis-2025.3.0.0/algorithms/{algorithmName}/randomize-key' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Success

Bodyapplication/json

algorithmNamestring<= 201 charactersrequired

Equivalent to the algorithm name saved by the user through the GUI. For out of the box algo, this represents algorithm code.

Example: "SimpleMaskingAlgorithm"

legacyNamestring<= 201 charactersread-only

This represents algorithm name shown on the UI.

algorithmTypestringrequired

The type of algorithm

Default "COMPONENT"

Enum"BINARY_LOOKUP""CLEANSING""COMPONENT""CUSTOM_ALGORITHM""DATE""LOOKUP""MAPPING""MINMAX""MISC""REDACTION"

Example: "COMPONENT"

createdBystring<= 255 charactersread-only

The name of the user that created the algorithm

descriptionstring

The description of the algorithm

Example: "This is a simple algorithm that serves as an example for the API. The frameworkId value may vary by engine."

maskTypestringread-only

The masking type of the algorithm

isTokenizationSupportedbooleanread-only

Whether or not the algorithm can be used with tokenization and reidentification job

frameworkIdinteger(int64)

The algorithm framework id

Example: 3

frameworkNamestringread-only

The algorithm framework name

jsonConfigurablebooleanread-only

The algorithm is json Configurable or not.

pluginIdinteger(int64)read-only

The id, if applicable, of the plugin that supplies this algorithm or the framework this algorithm is built on

Example: 7

fieldsArray of objects(AlgorithmField)

algorithmExtensionobject

Example: {"lookupFile":{"uri":"delphix-file://upload/f_a0c6c02dac4a4303a26ea5418fb72d5b/example.txt"}}

isConfigInvalidbooleanread-only

Whether or not the configuration in algorithmExtension is invalid

Response

application/json

{
  "algorithmName": "SimpleMaskingAlgorithm",
  "algorithmType": "COMPONENT",
  "description": "This is a simple algorithm that serves as an example for the API. The frameworkId value may vary by engine.",
  "pluginId": 7,
  "frameworkId": 3,
  "algorithmExtension": {
    "lookupFile": { … }
  }
}

Generate a report listing all usage of an algorithm on the masking engine

Request

Security

api_key

Path

algorithmNamestringrequired

The name of the algorithm

Query

includeAssignmentDetailbooleanrequired

Whether to include extended, human-readable algorithm assignment detail in the report. File and mainframe format usages are expanded to show each usage across environments, rulesets and files. The content and ordering of these details are subject to change.

Default false

excludeChainedAlgorithmsboolean

Whether to exclude chained algorithm. This parameter will skip the computation of referencing algorithms

Default false

environmentFilterArray of strings

Report only usage occurring within the specified environment(s). When the algorithm is used in a file format, all usage of that file format is reported so long as it is referenced by any environment matching the filter. Filtering by environment excludes all domain and algorithm reference usage.

rulesetFilterArray of strings

Report only usage occurring within the specified ruleset(s). When the algorithm is used in a file format, all usage of that file format is reported so long as it is referenced by any ruleset matching the filter. Filtering by ruleset excludes all domain and algorithm reference usage.

curl -i -X GET \
  'https://help-api.delphix.com/_mock/continuous-compliance-engine/2025.3.0.0/cc-engine-apis-2025.3.0.0/algorithms/{algorithmName}/usage?includeAssignmentDetail=false&excludeChainedAlgorithms=false&environmentFilter=string&rulesetFilter=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Success

Bodyapplication/json

algorithmNamestringread-onlyrequired

The name of the algorithm to which this usage report applies.

algorithmMaskingTypestringread-only

The type of value this algorithm masks. This value is only available for algorithms based on the Algorithm Extensibility Framework.

Enum"BIG_DECIMAL""LOCAL_DATE_TIME""STRING""BYTE_BUFFER""GENERIC_DATA_ROW""ADVANCED_OBJECT"

columnMetadataIdsArray of integers(int64)

A list of the IDs of all columnMetadata objects that reference the algorithm.

fileFieldMetadataIdsArray of integers(int64)

A list of the IDs of all fileFieldMetadata objects that reference the algorithm.

mainframeDatasetFieldMetadataIdsArray of integers(int64)

A list of the IDs of all mainframeDatasetFieldMetadata objects that reference the algorithm.

environmentIdsArray of integers(int64)

A list of the IDs of all environments where the algorithm is used.

rulesetIdsArray of integers(int64)

A list of the IDs of all rulesets where the algorithm is used.

domainNamesArray of strings

A list of the names of all domains that reference the algorithm.

algorithmReferencesArray of strings

A list of the names of all other algorithms contain references to this algorithm.

assignmentDetailsArray of objects(AlgorithmAssignmentDetail)

A extended usage objects that describe the full path to each algorithm usage for all column, file and mainframe dataset assignments.

Response

application/json

{
  "algorithmName": "string",
  "algorithmMaskingType": "BIG_DECIMAL",
  "columnMetadataIds": [
    0
  ],
  "fileFieldMetadataIds": [
    0
  ],
  "mainframeDatasetFieldMetadataIds": [
    0
  ],
  "environmentIds": [
    0
  ],
  "rulesetIds": [
    0
  ],
  "domainNames": [
    "string"
  ],
  "algorithmReferences": [
    "string"
  ],
  "assignmentDetails": [
    { … }
  ]
}

Update ALL usage on the engine of the chosen algorithm to the replacement algorithm

Request

Security

api_key

Path

algorithmNamestringrequired

The name of the algorithm

Query

replacementAlgorithmNamestringrequired

The name of the replacement algorithm

ignoreIncompatibleTypesbooleanrequired

Update usage even when the original and new algorithms have incompatible masking types.

Default false

environmentFilterArray of strings

Only update usage occurring within the specified environment(s). When an environment filter is applied, domain and algorithm reference usage is not updated. This operation will fail if any file format referencing the algorithm is used from environments that don't match the filter.

rulesetFilterArray of strings

Only update usage occurring within the specified ruleset(s). When a ruleset filter is applied, domain and algorithm reference usage is not updated. This operation will fail if any file format referencing the algorithm is used from rulesets that don't match the filter.

curl -i -X PUT \
  'https://help-api.delphix.com/_mock/continuous-compliance-engine/2025.3.0.0/cc-engine-apis-2025.3.0.0/algorithms/{algorithmName}/usage?replacementAlgorithmName=string&ignoreIncompatibleTypes=false&environmentFilter=string&rulesetFilter=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Success

Bodyapplication/json

algorithmNamestringread-onlyrequired

The name of the algorithm to which this usage report applies.

algorithmMaskingTypestringread-only

The type of value this algorithm masks. This value is only available for algorithms based on the Algorithm Extensibility Framework.

Enum"BIG_DECIMAL""LOCAL_DATE_TIME""STRING""BYTE_BUFFER""GENERIC_DATA_ROW""ADVANCED_OBJECT"

columnMetadataIdsArray of integers(int64)

A list of the IDs of all columnMetadata objects that reference the algorithm.

fileFieldMetadataIdsArray of integers(int64)

A list of the IDs of all fileFieldMetadata objects that reference the algorithm.

mainframeDatasetFieldMetadataIdsArray of integers(int64)

A list of the IDs of all mainframeDatasetFieldMetadata objects that reference the algorithm.

environmentIdsArray of integers(int64)

A list of the IDs of all environments where the algorithm is used.

rulesetIdsArray of integers(int64)

A list of the IDs of all rulesets where the algorithm is used.

domainNamesArray of strings

A list of the names of all domains that reference the algorithm.

algorithmReferencesArray of strings

A list of the names of all other algorithms contain references to this algorithm.

assignmentDetailsArray of objects(AlgorithmAssignmentDetail)

A extended usage objects that describe the full path to each algorithm usage for all column, file and mainframe dataset assignments.

Response

application/json

{
  "algorithmName": "string",
  "algorithmMaskingType": "BIG_DECIMAL",
  "columnMetadataIds": [
    0
  ],
  "fileFieldMetadataIds": [
    0
  ],
  "mainframeDatasetFieldMetadataIds": [
    0
  ],
  "environmentIds": [
    0
  ],
  "rulesetIds": [
    0
  ],
  "domainNames": [
    "string"
  ],
  "algorithmReferences": [
    "string"
  ],
  "assignmentDetails": [
    { … }
  ]
}

Export lookup values for secure lookup algorithm

Request

Security

api_key

Path

algorithmNamestringrequired

The name of the algorithm

curl -i -X POST \
  'https://help-api.delphix.com/_mock/continuous-compliance-engine/2025.3.0.0/cc-engine-apis-2025.3.0.0/algorithms/{algorithmName}/export-lookup-values' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Success

Bodyapplication/json

asyncTaskIdinteger(int32)read-only

The ID of the AsyncTask. This field will be generated by the Masking Engine.

Example: 1

operationstringread-only

The type of operation that the AsyncTask is performing.

Enum"ADD_MAPPINGS""ALGORITHM_CREATE""ALGORITHM_MIGRATE""ALGORITHM_UPDATE""DATAFILE_BULK_UPDATE""ENCRYPTION_KEY_CREATE""EXPORT""EXPORT_CLASSIFIER_FILES""EXPORT_MAPPINGS""EXPORT_PROFILE_SET"

Example: "RULESET_REFRESH"

referencestring<= 255 charactersread-only

The reference for the AsyncTask. An example of a reference is the ruleset ID for a RULESET_REFRESH operation.

Example: 13

statusstringread-only

The status of the AsyncTask in regard to its completion.

Enum"CANCELLED""FAILED""RUNNING""SUCCEEDED""WAITING"

Example: "RUNNING"

startTimestring(date-time)read-only

The date and time that this AsyncTask was started.

endTimestring(date-time)read-only

The date and time that this AsyncTask completed.

cancellablebooleanread-only

True if the AsyncTask can be cancelled, false otherwise.

exceptionDetailstringread-only

The details associated with the Java exception that caused this async task to fail, if applicable.

Response

application/json

{
  "asyncTaskId": 1,
  "operation": "RULESET_REFRESH",
  "reference": 13,
  "status": "RUNNING",
  "cancellable": false
}

Validate algorithm

Request

Security

api_key

Bodyapplication/jsonrequired

The algorithm to validate

algorithmNamestring<= 201 charactersrequired

Equivalent to the algorithm name saved by the user through the GUI. For out of the box algo, this represents algorithm code.

Example: "SimpleMaskingAlgorithm"

algorithmTypestringrequired

The type of algorithm

Default "COMPONENT"

Enum"BINARY_LOOKUP""CLEANSING""COMPONENT""CUSTOM_ALGORITHM""DATE""LOOKUP""MAPPING""MINMAX""MISC""REDACTION"

Example: "COMPONENT"

descriptionstring

The description of the algorithm

Example: "This is a simple algorithm that serves as an example for the API. The frameworkId value may vary by engine."

frameworkIdinteger(int64)

The algorithm framework id

Example: 3

fieldsArray of objects(AlgorithmField)

algorithmExtensionobject

Example: {"lookupFile":{"uri":"delphix-file://upload/f_a0c6c02dac4a4303a26ea5418fb72d5b/example.txt"}}

curl -i -X POST \
  https://help-api.delphix.com/_mock/continuous-compliance-engine/2025.3.0.0/cc-engine-apis-2025.3.0.0/algorithms/validate \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "algorithmName": "SimpleMaskingAlgorithm",
    "algorithmType": "COMPONENT",
    "description": "This is a simple algorithm that serves as an example for the API. The frameworkId value may vary by engine.",
    "pluginId": 7,
    "frameworkId": 3,
    "algorithmExtension": {
      "lookupFile": {
        "uri": "delphix-file://upload/f_a0c6c02dac4a4303a26ea5418fb72d5b/example.txt"
      }
    }
  }'

Responses

Success

Bodyapplication/json

validationSucceededbooleanread-onlyrequired

Whether or not the validation was successful

Example: true

messagestringread-onlyrequired

The message providing more details about the validation

Example: "Algorithm validation successful"

Response

application/json

{
  "validationSucceeded": true,
  "message": "Algorithm validation successful"
}

Get all algorithm frameworks

Request

Security

api_key

Query

mask_typestring

Return only frameworks that mask the specified data type.

Enum"BIG_DECIMAL""LOCAL_DATE_TIME""STRING""BYTE_BUFFER""GENERIC_DATA_ROW"

include_schemaboolean

Whether to include each algorithm framework's JSON schema in the response.

Default false

page_numberinteger(int64)

The page number for which to get algorithm frameworks. 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

curl -i -X GET \
  'https://help-api.delphix.com/_mock/continuous-compliance-engine/2025.3.0.0/cc-engine-apis-2025.3.0.0/algorithm/frameworks?mask_type=BIG_DECIMAL&include_schema=false&page_number=1&page_size=0' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Success

Bodyapplication/json

_pageInfoobject(PageInfo)

responseListArray of objects(AlgorithmFramework)

Example: [{"frameworkId":1,"frameworkName":"MinMax","frameworkType":"STRING","plugin":{"pluginId":1,"pluginName":"myPlugin","pluginAuthor":"pluginAuthor"}}]

Response

application/json

{
  "_pageInfo": {
    "numberOnPage": 0,
    "total": 0
  },
  "responseList": [
    { … }
  ]
}

Get algorithm framework by frameworkId

Request

Security

api_key

Path

frameworkIdinteger(int64)required

The id of the framework

Query

include_schemaboolean

Whether to include each algorithm framework's JSON schema in the response.

Default false

curl -i -X GET \
  'https://help-api.delphix.com/_mock/continuous-compliance-engine/2025.3.0.0/cc-engine-apis-2025.3.0.0/algorithm/frameworks/id/{frameworkId}?include_schema=false' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Success

Bodyapplication/json

frameworkIdinteger(int64)read-only

The id of the algorithm framework installed using Plugin API.

Example: 1

frameworkNamestring<= 255 characters

The name of the algorithm framework installed using Plugin API.

Example: "MinMax"

frameworkTypestring

The type of value this algorithm framework masks.

Enum"BIG_DECIMAL""LOCAL_DATE_TIME""STRING""BYTE_BUFFER""GENERIC_DATA_ROW""ADVANCED_OBJECT"

Example: "STRING"

descriptionstring

The description of the algorithm framework

pluginobject(PluginBase)

Example: {"pluginId":1,"pluginName":"myPlugin","pluginAuthor":"pluginAuthor","pluginType":"EXTENDED_ALGORITHM"}

fieldsArray of objects(AlgorithmField)

extensionSchemaobject

The JSON schema of algorithmExtension used by this framework

Response

application/json

{
  "frameworkId": 1,
  "frameworkName": "MinMax",
  "frameworkType": "STRING",
  "plugin": {
    "pluginId": 1,
    "pluginName": "myPlugin",
    "pluginAuthor": "pluginAuthor"
  }
}

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

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

Masking API (5.1.43)CopyCopy for LLMCopy page as Markdown for LLMsView as MarkdownOpen this page as MarkdownOpen in ChatGPTGet insights from ChatGPTOpen in ClaudeGet insights from ClaudeConnect to CursorInstall MCP server on CursorConnect to VS CodeInstall MCP server on VS Code

algorithm

Get all algorithms

Request

Responses

Was this helpful?

Create algorithm

RequestExpand all

Responses

Was this helpful?

Get algorithm by name

Request

Responses

Was this helpful?

Update algorithm by name

RequestExpand all

Responses

Was this helpful?

Delete algorithm by name

Request

Responses

Was this helpful?

Get a list of all algorithms that support migration to a new framework

Request

Responses

Was this helpful?

Create a migrated copy of an existing legacy algorithm

Request

Responses

Was this helpful?

Randomize algorithm key by name

Request

Responses

Was this helpful?

Generate a report listing all usage of an algorithm on the masking engine

Request

Responses

Was this helpful?

Update ALL usage on the engine of the chosen algorithm to the replacement algorithm

Request

Responses

Was this helpful?

Export lookup values for secure lookup algorithm

Request

Responses

Was this helpful?

Validate algorithm

RequestExpand all

Responses

Was this helpful?

Get all algorithm frameworks

Request

Responses

Was this helpful?

Get algorithm framework by frameworkId

Request

Responses

Was this helpful?

logging

application

applicationSettings

asyncTask

billingUsage

classifier

columnMetadata

credentialPath

configuration

databaseConnector

databaseRuleset

domain

encryptionKey

environment

execution

executionComponent

executionEvent

sync

fileConnector

fileDownload

fileFieldMetadata

fileFormat

Masking API (5.1.43)
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude
Connect to Cursor
Install MCP server on Cursor
Connect to VS Code
Install MCP server on VS Code

Request

Request

Request