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

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

Get all profile jobs

Request

Security
api_key
Query
page_numberinteger(int64)

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

environment_idinteger(int32)

The ID of the environment to get all profile jobs from

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

Responses

Success

Bodyapplication/json
_pageInfoobject(PageInfo)
responseListArray of objects(ProfileJob)
Example: [{"jobName":"minimal_profile_job","profileSetId":2,"rulesetId":7,"jobDescription":"This example value illustrates the minimal set of fields required to create a ProfileJob. All other fields have default values. Refer to the extensive documentation on the ProfileJob object for reference on the other, optional fields."}]
Response
application/json
{
  "_pageInfo": {
    "numberOnPage": 0,
    "total": 0
  },
  "responseList": [
    { … }
  ]
}

Create profile job

Request

Security
api_key
Bodyapplication/jsonrequired

The profile job to create

jobNamestring<= 255 charactersrequired

The name of the profile job. Once the profile job is created, this field cannot be changed.

Example: "minimal_profile_job"
profileSetIdinteger(int32)required

The ID number of the profile set to be used during the profiling phase.

Example: 2
rulesetIdinteger(int32)required

The ID of the ruleset that this profile job is targeting. Once the profile job is created, the underlying environment that is inferred from the ruleset will be unchangeable. That is, the job can only be updated to reference a ruleset that is in the same environment as the environment of the original ruleset.

Example: 7
emailstring

The email address to send job status notifications to; note that the SMTP settings must be configured first to receive notifications.

feedbackSizeinteger(int32)>= 1

The granularity with which the Masking Engine provides updates on the progress of the profile job. For instance, a feedbackSize of 50000 results in log updates whenever 50000 rows are processed during the profiling phase.

jobDescriptionstring<= 255 characters

A description of the job.

Example: "This example value illustrates the minimal set of fields required to create a ProfileJob. All other fields have default values. Refer to the extensive documentation on the ProfileJob object for reference on the other, optional fields."
maxMemoryinteger(int32)

The maximum amount of memory, in MB, that the profile job can consume during execution.

minMemoryinteger(int32)

The minimum amount of memory, in MB, that the profile job can consume during execution.

multiTenantboolean

This field determines whether the profile job, after creation, can be executed using a connector that is different from the underlying connector associated with the ruleset that this profile job is targeting.

Default false
numInputStreamsinteger(int32)>= 1

This field controls the amount of parallelism that the profile job uses to extract out the data to be profiled. For instance, when profiling a database, specifying 5 input streams results in the profile job reading up to 5 database tables in parallel and then profiling those 5 streams of data in parallel. The higher the value of this field, the more potential parallelism there will be in the job, but the profile job will consume more memory. If the number of input streams exceeds the number of units being profiled (e.g. tables or files), then the excess streams will do nothing.

Default 1
multipleProfilerCheckboolean

This field determines whether the profiler stops after it flags a field as sensitive or if it continues to scan for more sensitive patterns.

Default false
resetProfilingAssignmentsboolean or null

This field determines whether the inventory domain assignments for the previous profiling execution needs to be cleared before the current execution of an ASDD job (defaults to 'false'). This field has no effect on legacy profiling and is always 'true'.

curl -i -X POST \
  https://help-api.delphix.com/_mock/continuous-compliance-engine/2025.2.0.0/cc-engine-apis-2025.2.0.0/profile-jobs \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "jobName": "minimal_profile_job",
    "profileSetId": 2,
    "rulesetId": 7,
    "jobDescription": "This example value illustrates the minimal set of fields required to create a ProfileJob. All other fields have default values. Refer to the extensive documentation on the ProfileJob object for reference on the other, optional fields."
  }'

Responses

Success

Bodyapplication/json
profileJobIdinteger(int32)read-only

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

jobNamestring<= 255 charactersrequired

The name of the profile job. Once the profile job is created, this field cannot be changed.

Example: "minimal_profile_job"
profileSetIdinteger(int32)required

The ID number of the profile set to be used during the profiling phase.

Example: 2
rulesetIdinteger(int32)required

The ID of the ruleset that this profile job is targeting. Once the profile job is created, the underlying environment that is inferred from the ruleset will be unchangeable. That is, the job can only be updated to reference a ruleset that is in the same environment as the environment of the original ruleset.

Example: 7
rulesetTypestringread-only

The type of the ruleset that this profile job is assigned to.

createdBystring<= 255 charactersread-only

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

createdTimestring(date-time)read-only

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

emailstring

The email address to send job status notifications to; note that the SMTP settings must be configured first to receive notifications.

feedbackSizeinteger(int32)>= 1

The granularity with which the Masking Engine provides updates on the progress of the profile job. For instance, a feedbackSize of 50000 results in log updates whenever 50000 rows are processed during the profiling phase.

jobDescriptionstring<= 255 characters

A description of the job.

Example: "This example value illustrates the minimal set of fields required to create a ProfileJob. All other fields have default values. Refer to the extensive documentation on the ProfileJob object for reference on the other, optional fields."
maxMemoryinteger(int32)

The maximum amount of memory, in MB, that the profile job can consume during execution.

minMemoryinteger(int32)

The minimum amount of memory, in MB, that the profile job can consume during execution.

multiTenantboolean

This field determines whether the profile job, after creation, can be executed using a connector that is different from the underlying connector associated with the ruleset that this profile job is targeting.

Default false
numInputStreamsinteger(int32)>= 1

This field controls the amount of parallelism that the profile job uses to extract out the data to be profiled. For instance, when profiling a database, specifying 5 input streams results in the profile job reading up to 5 database tables in parallel and then profiling those 5 streams of data in parallel. The higher the value of this field, the more potential parallelism there will be in the job, but the profile job will consume more memory. If the number of input streams exceeds the number of units being profiled (e.g. tables or files), then the excess streams will do nothing.

Default 1
multipleProfilerCheckboolean

This field determines whether the profiler stops after it flags a field as sensitive or if it continues to scan for more sensitive patterns.

Default false
resetProfilingAssignmentsboolean or null

This field determines whether the inventory domain assignments for the previous profiling execution needs to be cleared before the current execution of an ASDD job (defaults to 'false'). This field has no effect on legacy profiling and is always 'true'.

Response
application/json
{
  "jobName": "minimal_profile_job",
  "profileSetId": 2,
  "rulesetId": 7,
  "jobDescription": "This example value illustrates the minimal set of fields required to create a ProfileJob. All other fields have default values. Refer to the extensive documentation on the ProfileJob object for reference on the other, optional fields."
}

Get profile job by ID

Request

Security
api_key
Path
profileJobIdinteger(int32)required

The ID of the profile job 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/profile-jobs/{profileJobId}' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Success

Bodyapplication/json
profileJobIdinteger(int32)read-only

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

jobNamestring<= 255 charactersrequired

The name of the profile job. Once the profile job is created, this field cannot be changed.

Example: "minimal_profile_job"
profileSetIdinteger(int32)required

The ID number of the profile set to be used during the profiling phase.

Example: 2
rulesetIdinteger(int32)required

The ID of the ruleset that this profile job is targeting. Once the profile job is created, the underlying environment that is inferred from the ruleset will be unchangeable. That is, the job can only be updated to reference a ruleset that is in the same environment as the environment of the original ruleset.

Example: 7
rulesetTypestringread-only

The type of the ruleset that this profile job is assigned to.

createdBystring<= 255 charactersread-only

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

createdTimestring(date-time)read-only

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

emailstring

The email address to send job status notifications to; note that the SMTP settings must be configured first to receive notifications.

feedbackSizeinteger(int32)>= 1

The granularity with which the Masking Engine provides updates on the progress of the profile job. For instance, a feedbackSize of 50000 results in log updates whenever 50000 rows are processed during the profiling phase.

jobDescriptionstring<= 255 characters

A description of the job.

Example: "This example value illustrates the minimal set of fields required to create a ProfileJob. All other fields have default values. Refer to the extensive documentation on the ProfileJob object for reference on the other, optional fields."
maxMemoryinteger(int32)

The maximum amount of memory, in MB, that the profile job can consume during execution.

minMemoryinteger(int32)

The minimum amount of memory, in MB, that the profile job can consume during execution.

multiTenantboolean

This field determines whether the profile job, after creation, can be executed using a connector that is different from the underlying connector associated with the ruleset that this profile job is targeting.

Default false
numInputStreamsinteger(int32)>= 1

This field controls the amount of parallelism that the profile job uses to extract out the data to be profiled. For instance, when profiling a database, specifying 5 input streams results in the profile job reading up to 5 database tables in parallel and then profiling those 5 streams of data in parallel. The higher the value of this field, the more potential parallelism there will be in the job, but the profile job will consume more memory. If the number of input streams exceeds the number of units being profiled (e.g. tables or files), then the excess streams will do nothing.

Default 1
multipleProfilerCheckboolean

This field determines whether the profiler stops after it flags a field as sensitive or if it continues to scan for more sensitive patterns.

Default false
resetProfilingAssignmentsboolean or null

This field determines whether the inventory domain assignments for the previous profiling execution needs to be cleared before the current execution of an ASDD job (defaults to 'false'). This field has no effect on legacy profiling and is always 'true'.

Response
application/json
{
  "jobName": "minimal_profile_job",
  "profileSetId": 2,
  "rulesetId": 7,
  "jobDescription": "This example value illustrates the minimal set of fields required to create a ProfileJob. All other fields have default values. Refer to the extensive documentation on the ProfileJob object for reference on the other, optional fields."
}

Update profile job by ID

Request

Security
api_key
Path
profileJobIdinteger(int32)required

The ID of the profile job to update

Bodyapplication/jsonrequired

The updated profile job

jobNamestring<= 255 charactersrequired

The name of the profile job. Once the profile job is created, this field cannot be changed.

Example: "minimal_profile_job"
profileSetIdinteger(int32)required

The ID number of the profile set to be used during the profiling phase.

Example: 2
rulesetIdinteger(int32)required

The ID of the ruleset that this profile job is targeting. Once the profile job is created, the underlying environment that is inferred from the ruleset will be unchangeable. That is, the job can only be updated to reference a ruleset that is in the same environment as the environment of the original ruleset.

Example: 7
emailstring

The email address to send job status notifications to; note that the SMTP settings must be configured first to receive notifications.

feedbackSizeinteger(int32)>= 1

The granularity with which the Masking Engine provides updates on the progress of the profile job. For instance, a feedbackSize of 50000 results in log updates whenever 50000 rows are processed during the profiling phase.

jobDescriptionstring<= 255 characters

A description of the job.

Example: "This example value illustrates the minimal set of fields required to create a ProfileJob. All other fields have default values. Refer to the extensive documentation on the ProfileJob object for reference on the other, optional fields."
maxMemoryinteger(int32)

The maximum amount of memory, in MB, that the profile job can consume during execution.

minMemoryinteger(int32)

The minimum amount of memory, in MB, that the profile job can consume during execution.

multiTenantboolean

This field determines whether the profile job, after creation, can be executed using a connector that is different from the underlying connector associated with the ruleset that this profile job is targeting.

Default false
numInputStreamsinteger(int32)>= 1

This field controls the amount of parallelism that the profile job uses to extract out the data to be profiled. For instance, when profiling a database, specifying 5 input streams results in the profile job reading up to 5 database tables in parallel and then profiling those 5 streams of data in parallel. The higher the value of this field, the more potential parallelism there will be in the job, but the profile job will consume more memory. If the number of input streams exceeds the number of units being profiled (e.g. tables or files), then the excess streams will do nothing.

Default 1
multipleProfilerCheckboolean

This field determines whether the profiler stops after it flags a field as sensitive or if it continues to scan for more sensitive patterns.

Default false
resetProfilingAssignmentsboolean or null

This field determines whether the inventory domain assignments for the previous profiling execution needs to be cleared before the current execution of an ASDD job (defaults to 'false'). This field has no effect on legacy profiling and is always 'true'.

curl -i -X PUT \
  'https://help-api.delphix.com/_mock/continuous-compliance-engine/2025.2.0.0/cc-engine-apis-2025.2.0.0/profile-jobs/{profileJobId}' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "jobName": "minimal_profile_job",
    "profileSetId": 2,
    "rulesetId": 7,
    "jobDescription": "This example value illustrates the minimal set of fields required to create a ProfileJob. All other fields have default values. Refer to the extensive documentation on the ProfileJob object for reference on the other, optional fields."
  }'

Responses

Success

Bodyapplication/json
profileJobIdinteger(int32)read-only

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

jobNamestring<= 255 charactersrequired

The name of the profile job. Once the profile job is created, this field cannot be changed.

Example: "minimal_profile_job"
profileSetIdinteger(int32)required

The ID number of the profile set to be used during the profiling phase.

Example: 2
rulesetIdinteger(int32)required

The ID of the ruleset that this profile job is targeting. Once the profile job is created, the underlying environment that is inferred from the ruleset will be unchangeable. That is, the job can only be updated to reference a ruleset that is in the same environment as the environment of the original ruleset.

Example: 7
rulesetTypestringread-only

The type of the ruleset that this profile job is assigned to.

createdBystring<= 255 charactersread-only

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

createdTimestring(date-time)read-only

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

emailstring

The email address to send job status notifications to; note that the SMTP settings must be configured first to receive notifications.

feedbackSizeinteger(int32)>= 1

The granularity with which the Masking Engine provides updates on the progress of the profile job. For instance, a feedbackSize of 50000 results in log updates whenever 50000 rows are processed during the profiling phase.

jobDescriptionstring<= 255 characters

A description of the job.

Example: "This example value illustrates the minimal set of fields required to create a ProfileJob. All other fields have default values. Refer to the extensive documentation on the ProfileJob object for reference on the other, optional fields."
maxMemoryinteger(int32)

The maximum amount of memory, in MB, that the profile job can consume during execution.

minMemoryinteger(int32)

The minimum amount of memory, in MB, that the profile job can consume during execution.

multiTenantboolean

This field determines whether the profile job, after creation, can be executed using a connector that is different from the underlying connector associated with the ruleset that this profile job is targeting.

Default false
numInputStreamsinteger(int32)>= 1

This field controls the amount of parallelism that the profile job uses to extract out the data to be profiled. For instance, when profiling a database, specifying 5 input streams results in the profile job reading up to 5 database tables in parallel and then profiling those 5 streams of data in parallel. The higher the value of this field, the more potential parallelism there will be in the job, but the profile job will consume more memory. If the number of input streams exceeds the number of units being profiled (e.g. tables or files), then the excess streams will do nothing.

Default 1
multipleProfilerCheckboolean

This field determines whether the profiler stops after it flags a field as sensitive or if it continues to scan for more sensitive patterns.

Default false
resetProfilingAssignmentsboolean or null

This field determines whether the inventory domain assignments for the previous profiling execution needs to be cleared before the current execution of an ASDD job (defaults to 'false'). This field has no effect on legacy profiling and is always 'true'.

Response
application/json
{
  "jobName": "minimal_profile_job",
  "profileSetId": 2,
  "rulesetId": 7,
  "jobDescription": "This example value illustrates the minimal set of fields required to create a ProfileJob. All other fields have default values. Refer to the extensive documentation on the ProfileJob object for reference on the other, optional fields."
}

Delete profile job by ID

Request

Security
api_key
Path
profileJobIdinteger(int32)required

The ID of the profile job 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/profile-jobs/{profileJobId}' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Success

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