Skip to content
/
Get classifier by ID

Masking API (5.1.45)

Schema for the Continuous Compliance Engine API

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

algorithm

Operations

logging

Operations

application

Operations

applicationSettings

Operations

asyncTask

Operations

billingUsage

Operations

classifier

Operations

Get all classifiers

Request

Security
api_key
Query
page_numberinteger(int64)

The page number for which to get classifiers. 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.5.0.0/cc-engine-apis-2025.5.0.0/classifiers?page_number=1&page_size=0' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Success

Bodyapplication/json
_pageInfoobject(PageInfo)
responseListArray of objects(Classifier)
Example: [{"classifierName":"MyClassifier","description":"Detects my sensitive data","frameworkId":1,"domainName":"MyDomain","classifierConfiguration":{"dataPatterns":[{"regex":"[A-Za-z0-9]*","matchStrength":0.1}]}}]
Response
application/json
{
  "_pageInfo": {
    "numberOnPage": 0,
    "total": 0
  },
  "responseList": [
    { … }
  ]
}

Create classifier

Request

Security
api_key
Bodyapplication/jsonrequired

The classifier to create

classifierNamestring<= 100 charactersrequired

The name of this classifier. Note that it must be unique.

Example: "MyClassifier"
descriptionstring

The description of the classifier.

Example: "Detects my sensitive data"
frameworkIdinteger(int64)

The id of the classifier framework.

Example: 1
domainNamestring<= 100 characters

The name of the domain that will be assigned to the column/field when a profile expression match is found during the execution of a profile job.

Example: "MyDomain"
classifierConfigurationobject
Example: {"dataPatterns":[{"regex":"[A-Za-z0-9]*","matchStrength":0.1}]}
curl -i -X POST \
  https://help-api.delphix.com/_mock/continuous-compliance-engine/2025.5.0.0/cc-engine-apis-2025.5.0.0/classifiers \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "classifierName": "MyClassifier",
    "description": "Detects my sensitive data",
    "frameworkId": 1,
    "domainName": "MyDomain",
    "classifierConfiguration": {
      "dataPatterns": [
        {
          "regex": "[A-Za-z0-9]*",
          "matchStrength": 0.1
        }
      ]
    }
  }'

Responses

Success

Bodyapplication/json
classifierIdinteger(int64)read-only

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

classifierNamestring<= 100 charactersrequired

The name of this classifier. Note that it must be unique.

Example: "MyClassifier"
descriptionstring

The description of the classifier.

Example: "Detects my sensitive data"
frameworkIdinteger(int64)

The id of the classifier framework.

Example: 1
domainNamestring<= 100 characters

The name of the domain that will be assigned to the column/field when a profile expression match is found during the execution of a profile job.

Example: "MyDomain"
createdBystring<= 255 charactersread-only

The user that created the profile expression. This field is auto-generated by the Masking Engine.

classifierConfigurationobject
Example: {"dataPatterns":[{"regex":"[A-Za-z0-9]*","matchStrength":0.1}]}
Response
application/json
{
  "classifierName": "MyClassifier",
  "description": "Detects my sensitive data",
  "frameworkId": 1,
  "domainName": "MyDomain",
  "classifierConfiguration": {
    "dataPatterns": [ … ]
  }
}

Get classifier by ID

Request

Security
api_key
Path
classifierIdinteger(int64)required

The ID of the classifier to get

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

Responses

Success

Bodyapplication/json
classifierIdinteger(int64)read-only

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

classifierNamestring<= 100 charactersrequired

The name of this classifier. Note that it must be unique.

Example: "MyClassifier"
descriptionstring

The description of the classifier.

Example: "Detects my sensitive data"
frameworkIdinteger(int64)

The id of the classifier framework.

Example: 1
domainNamestring<= 100 characters

The name of the domain that will be assigned to the column/field when a profile expression match is found during the execution of a profile job.

Example: "MyDomain"
createdBystring<= 255 charactersread-only

The user that created the profile expression. This field is auto-generated by the Masking Engine.

classifierConfigurationobject
Example: {"dataPatterns":[{"regex":"[A-Za-z0-9]*","matchStrength":0.1}]}
Response
application/json
{
  "classifierName": "MyClassifier",
  "description": "Detects my sensitive data",
  "frameworkId": 1,
  "domainName": "MyDomain",
  "classifierConfiguration": {
    "dataPatterns": [ … ]
  }
}

Update classifier by ID

Request

Security
api_key
Path
classifierIdinteger(int64)required

The ID of the classifier to update

Bodyapplication/jsonrequired

The classifier

classifierNamestring<= 100 charactersrequired

The name of this classifier. Note that it must be unique.

Example: "MyClassifier"
descriptionstring

The description of the classifier.

Example: "Detects my sensitive data"
frameworkIdinteger(int64)

The id of the classifier framework.

Example: 1
domainNamestring<= 100 characters

The name of the domain that will be assigned to the column/field when a profile expression match is found during the execution of a profile job.

Example: "MyDomain"
classifierConfigurationobject
Example: {"dataPatterns":[{"regex":"[A-Za-z0-9]*","matchStrength":0.1}]}
curl -i -X PUT \
  'https://help-api.delphix.com/_mock/continuous-compliance-engine/2025.5.0.0/cc-engine-apis-2025.5.0.0/classifiers/{classifierId}' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "classifierName": "MyClassifier",
    "description": "Detects my sensitive data",
    "frameworkId": 1,
    "domainName": "MyDomain",
    "classifierConfiguration": {
      "dataPatterns": [
        {
          "regex": "[A-Za-z0-9]*",
          "matchStrength": 0.1
        }
      ]
    }
  }'

Responses

Success

Bodyapplication/json
classifierIdinteger(int64)read-only

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

classifierNamestring<= 100 charactersrequired

The name of this classifier. Note that it must be unique.

Example: "MyClassifier"
descriptionstring

The description of the classifier.

Example: "Detects my sensitive data"
frameworkIdinteger(int64)

The id of the classifier framework.

Example: 1
domainNamestring<= 100 characters

The name of the domain that will be assigned to the column/field when a profile expression match is found during the execution of a profile job.

Example: "MyDomain"
createdBystring<= 255 charactersread-only

The user that created the profile expression. This field is auto-generated by the Masking Engine.

classifierConfigurationobject
Example: {"dataPatterns":[{"regex":"[A-Za-z0-9]*","matchStrength":0.1}]}
Response
application/json
{
  "classifierName": "MyClassifier",
  "description": "Detects my sensitive data",
  "frameworkId": 1,
  "domainName": "MyDomain",
  "classifierConfiguration": {
    "dataPatterns": [ … ]
  }
}

Delete classifier by ID

Request

Security
api_key
Path
classifierIdinteger(int64)required

The ID of the classifier to delete

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

Responses

Success

Copy classifier by ID

Request

Security
api_key
Path
classifierIdinteger(int64)required

The ID of the classifier to copy

Bodyapplication/jsonrequired

The name of the classifier to create

newClassifierNamestring<= 201 charactersrequired

The name of the classifier. This must be unique.

Example: "NewClassifier"
curl -i -X POST \
  'https://help-api.delphix.com/_mock/continuous-compliance-engine/2025.5.0.0/cc-engine-apis-2025.5.0.0/classifiers/{classifierId}/copy' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "newClassifierName": "NewClassifier"
  }'

Responses

Success

Bodyapplication/json
classifierIdinteger(int64)read-only

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

classifierNamestring<= 100 charactersrequired

The name of this classifier. Note that it must be unique.

Example: "MyClassifier"
descriptionstring

The description of the classifier.

Example: "Detects my sensitive data"
frameworkIdinteger(int64)

The id of the classifier framework.

Example: 1
domainNamestring<= 100 characters

The name of the domain that will be assigned to the column/field when a profile expression match is found during the execution of a profile job.

Example: "MyDomain"
createdBystring<= 255 charactersread-only

The user that created the profile expression. This field is auto-generated by the Masking Engine.

classifierConfigurationobject
Example: {"dataPatterns":[{"regex":"[A-Za-z0-9]*","matchStrength":0.1}]}
Response
application/json
{
  "classifierName": "MyClassifier",
  "description": "Detects my sensitive data",
  "frameworkId": 1,
  "domainName": "MyDomain",
  "classifierConfiguration": {
    "dataPatterns": [ … ]
  }
}

Export a zip file containing the files used for the specified classifier

Request

Security
api_key
Path
classifierIdinteger(int64)required

The ID of the classifier

curl -i -X POST \
  'https://help-api.delphix.com/_mock/continuous-compliance-engine/2025.5.0.0/cc-engine-apis-2025.5.0.0/classifiers/{classifierId}/export-files' \
  -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
}

Get all classifier frameworks

Request

Security
api_key
Query
include_schemaboolean

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

Default false
page_numberinteger(int64)

The page number for which to get classifier 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.5.0.0/cc-engine-apis-2025.5.0.0/classifiers/frameworks?include_schema=false&page_number=1&page_size=0' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Success

Bodyapplication/json
_pageInfoobject(PageInfo)
responseListArray of objects(ClassifierFramework)
Example: [{"frameworkId":1,"frameworkName":"REGEX","description":"This is a regex classifier framework."}]
Response
application/json
{
  "_pageInfo": {
    "numberOnPage": 0,
    "total": 0
  },
  "responseList": [
    { … }
  ]
}

Get classifier framework by frameworkId

Request

Security
api_key
Path
frameworkIdinteger(int64)required

The id of the framework

Query
include_schemaboolean

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

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

Responses

Success

Bodyapplication/json
frameworkIdinteger(int64)read-only

The id of the classifier framework installed using Plugin API.

Example: 1
frameworkNamestring<= 255 characters

The name of the classifier framework installed using Plugin API.

Example: "REGEX"
descriptionstring

The description of the classifier framework

Example: "This is a regex classifier framework."
classifierSchemaobject

The JSON schema of classifierExtension used by this framework

Response
application/json
{
  "frameworkId": 1,
  "frameworkName": "REGEX",
  "description": "This is a regex classifier framework."
}

Search classifiers

Request

Security
api_key
Query
page_numberinteger(int64)

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

sortstring

The field to sort results by. A property name with a prepended '-' signifies a descending order.

Enum"classifierId""-classifierId""classifierName""-classifierName""frameworkId""-frameworkId""createdDate""-createdDate""domainName""-domainName"
Bodyapplication/json

A request body containing a filter expression. Refer to the documentation to learn the syntax for filter-queries. Supported filterable attributes: "classifierId", "classifierName", "frameworkId", "createdDate", "domainName", "description"

curl -i -X POST \
  'https://help-api.delphix.com/_mock/continuous-compliance-engine/2025.5.0.0/cc-engine-apis-2025.5.0.0/classifiers/search?page_number=1&page_size=0&sort=classifierId' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "filter_expression": "<attribute> EQ 123"
  }'

Responses

Success

Bodyapplication/json
_pageInfoobject(PageInfo)
responseListArray of objects(Classifier)
Example: [{"classifierName":"MyClassifier","description":"Detects my sensitive data","frameworkId":1,"domainName":"MyDomain","classifierConfiguration":{"dataPatterns":[{"regex":"[A-Za-z0-9]*","matchStrength":0.1}]}}]
Response
application/json
{
  "_pageInfo": {
    "numberOnPage": 0,
    "total": 0
  },
  "responseList": [
    { … }
  ]
}

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