Skip to content
/
Generate a report listing...

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

profileJob

Operations

profileSet

Operations

Get all profile sets

Request

Security
api_key
Query
page_numberinteger(int64)

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

Responses

Success

Bodyapplication/json
_pageInfoobject(PageInfo)
responseListArray of objects(ProfileSet)
Example: [{"profileSetName":"FINDS_ALL_SENSITIVE_DATA","classifierIds":[4,8,12,13,27]}]
Response
application/json
{
  "_pageInfo": {
    "numberOnPage": 0,
    "total": 0
  },
  "responseList": [
    { … }
  ]
}

Create profile set

Request

Security
api_key
Bodyapplication/jsonrequired

The profile set to create

profileSetNamestring<= 50 charactersrequired

The name of the profile set; it must be unique.

Example: "FINDS_ALL_SENSITIVE_DATA"
profileExpressionIdsArray of integers(int32)

Profile sets with profile expressions can no longer be created.

profileTypeExpressionIdsArray of integers(int32)

Profile sets with profile expressions can no longer be created.

classifierIdsArray of integers(int64)

The list of ID numbers that correspond to the profile classifiers that belong in this profile set.

Example: [4,8,12,13,27]
descriptionstring<= 50 characters

A description of the purpose of the profile set.

assignmentThresholdinteger(int32)

The confidence threshold that must be met or exceeded for the ASDD profiler to make a domain and algorithm assignment. This must be an integer from 1-100. If not specified, the value defaults to the application setting for ASDD called DefaultAssignmentThreshold.

curl -i -X POST \
  https://help-api.delphix.com/_mock/continuous-compliance-engine/2025.3.0.0/cc-engine-apis-2025.3.0.0/profile-sets \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "profileSetName": "FINDS_ALL_SENSITIVE_DATA",
    "classifierIds": [
      4,
      8,
      12,
      13,
      27
    ]
  }'

Responses

Success

Bodyapplication/json
profileSetIdinteger(int32)read-only

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

profileSetNamestring<= 50 charactersrequired

The name of the profile set; it must be unique.

Example: "FINDS_ALL_SENSITIVE_DATA"
profileExpressionIdsArray of integers(int32)

Profile sets with profile expressions can no longer be created.

profileTypeExpressionIdsArray of integers(int32)

Profile sets with profile expressions can no longer be created.

classifierIdsArray of integers(int64)

The list of ID numbers that correspond to the profile classifiers that belong in this profile set.

Example: [4,8,12,13,27]
createdBystring<= 255 charactersread-only

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

createdTimestring(date-time)read-only

The time when the profile set was created. This field is auto-generated by the Masking Engine.

descriptionstring<= 50 characters

A description of the purpose of the profile set.

assignmentThresholdinteger(int32)

The confidence threshold that must be met or exceeded for the ASDD profiler to make a domain and algorithm assignment. This must be an integer from 1-100. If not specified, the value defaults to the application setting for ASDD called DefaultAssignmentThreshold.

Response
application/json
{
  "profileSetName": "FINDS_ALL_SENSITIVE_DATA",
  "classifierIds": [
    4,
    8,
    12,
    13,
    27
  ]
}

Get profile set by ID

Request

Security
api_key
Path
profileSetIdinteger(int32)required

The ID of the profile set 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/profile-sets/{profileSetId}' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Success

Bodyapplication/json
profileSetIdinteger(int32)read-only

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

profileSetNamestring<= 50 charactersrequired

The name of the profile set; it must be unique.

Example: "FINDS_ALL_SENSITIVE_DATA"
profileExpressionIdsArray of integers(int32)

Profile sets with profile expressions can no longer be created.

profileTypeExpressionIdsArray of integers(int32)

Profile sets with profile expressions can no longer be created.

classifierIdsArray of integers(int64)

The list of ID numbers that correspond to the profile classifiers that belong in this profile set.

Example: [4,8,12,13,27]
createdBystring<= 255 charactersread-only

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

createdTimestring(date-time)read-only

The time when the profile set was created. This field is auto-generated by the Masking Engine.

descriptionstring<= 50 characters

A description of the purpose of the profile set.

assignmentThresholdinteger(int32)

The confidence threshold that must be met or exceeded for the ASDD profiler to make a domain and algorithm assignment. This must be an integer from 1-100. If not specified, the value defaults to the application setting for ASDD called DefaultAssignmentThreshold.

Response
application/json
{
  "profileSetName": "FINDS_ALL_SENSITIVE_DATA",
  "classifierIds": [
    4,
    8,
    12,
    13,
    27
  ]
}

Update profile set by ID

Request

Security
api_key
Path
profileSetIdinteger(int32)required

The ID of the profile set to update

Bodyapplication/jsonrequired

The updated profile set

profileSetNamestring<= 50 charactersrequired

The name of the profile set; it must be unique.

Example: "FINDS_ALL_SENSITIVE_DATA"
profileExpressionIdsArray of integers(int32)

Profile sets with profile expressions can no longer be created.

profileTypeExpressionIdsArray of integers(int32)

Profile sets with profile expressions can no longer be created.

classifierIdsArray of integers(int64)

The list of ID numbers that correspond to the profile classifiers that belong in this profile set.

Example: [4,8,12,13,27]
descriptionstring<= 50 characters

A description of the purpose of the profile set.

assignmentThresholdinteger(int32)

The confidence threshold that must be met or exceeded for the ASDD profiler to make a domain and algorithm assignment. This must be an integer from 1-100. If not specified, the value defaults to the application setting for ASDD called DefaultAssignmentThreshold.

curl -i -X PUT \
  'https://help-api.delphix.com/_mock/continuous-compliance-engine/2025.3.0.0/cc-engine-apis-2025.3.0.0/profile-sets/{profileSetId}' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "profileSetName": "FINDS_ALL_SENSITIVE_DATA",
    "classifierIds": [
      4,
      8,
      12,
      13,
      27
    ]
  }'

Responses

Success

Bodyapplication/json
profileSetIdinteger(int32)read-only

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

profileSetNamestring<= 50 charactersrequired

The name of the profile set; it must be unique.

Example: "FINDS_ALL_SENSITIVE_DATA"
profileExpressionIdsArray of integers(int32)

Profile sets with profile expressions can no longer be created.

profileTypeExpressionIdsArray of integers(int32)

Profile sets with profile expressions can no longer be created.

classifierIdsArray of integers(int64)

The list of ID numbers that correspond to the profile classifiers that belong in this profile set.

Example: [4,8,12,13,27]
createdBystring<= 255 charactersread-only

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

createdTimestring(date-time)read-only

The time when the profile set was created. This field is auto-generated by the Masking Engine.

descriptionstring<= 50 characters

A description of the purpose of the profile set.

assignmentThresholdinteger(int32)

The confidence threshold that must be met or exceeded for the ASDD profiler to make a domain and algorithm assignment. This must be an integer from 1-100. If not specified, the value defaults to the application setting for ASDD called DefaultAssignmentThreshold.

Response
application/json
{
  "profileSetName": "FINDS_ALL_SENSITIVE_DATA",
  "classifierIds": [
    4,
    8,
    12,
    13,
    27
  ]
}

Delete profile set by ID

Request

Security
api_key
Path
profileSetIdinteger(int32)required

The ID of the profile set 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/profile-sets/{profileSetId}' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Success

Export a zip file of the specified profile set's configuration JSON and the files used by its classifiers

Request

Security
api_key
Path
profileSetIdinteger(int32)required

The ID of the profile set

curl -i -X POST \
  'https://help-api.delphix.com/_mock/continuous-compliance-engine/2025.3.0.0/cc-engine-apis-2025.3.0.0/profile-sets/{profileSetId}/export' \
  -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
}

Generate a report listing all usage of profile sets on the masking engine

Request

Security
api_key
Query
includeAssignmentDetailbooleanrequired

Whether to include extended, human-readable profile set assignment detail in the report.

Default false
profileSetTypestring

Whether to filter by specific profile set type. If not specified, all profile set types are included.

Enum"ASDD""LEGACY"
connectorTypestring

Whether to filter by specific connector type. If not specified, all connector types are included.

Enum"DATABASE""FILE""MAINFRAME"
environmentFilterArray of strings

Report only usage occurring within the specified environment(s).

profileSetFilterArray of strings

Report only usage of the specified profile set(s).

curl -i -X GET \
  'https://help-api.delphix.com/_mock/continuous-compliance-engine/2025.3.0.0/cc-engine-apis-2025.3.0.0/profile-sets/usage?includeAssignmentDetail=false&profileSetType=ASDD&connectorType=DATABASE&environmentFilter=string&profileSetFilter=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Success

Bodyapplication/json
_pageInfoobject(PageInfo)
responseListArray of objects(ProfileSetUsageReport)
Response
application/json
{
  "_pageInfo": {
    "numberOnPage": 0,
    "total": 0
  },
  "responseList": [
    { … }
  ]
}

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