Skip to content

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

Get all asyncTasks

Request

Security
api_key
Query
operationstring

The operation type for which to get async tasks.

Enum"ALGORITHM_CREATE""ALGORITHM_MIGRATE""ALGORITHM_UPDATE""EXPORT""IMPORT""RULESET_REFRESH""SUPPORT_BUNDLE_GENERATE""TABLE_BULK_UPDATE"
statusstring

The status type for which to get async tasks.

Enum"CANCELLED""FAILED""RUNNING""SUCCEEDED""WAITING"
page_numberinteger(int64)

The page number for which to get asyncTasks. 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/async-tasks?operation=ALGORITHM_CREATE&status=CANCELLED&page_number=1&page_size=0' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Success

Bodyapplication/json
_pageInfoobject(PageInfo)
responseListArray of objects(AsyncTask)
Example: [{"asyncTaskId":1,"operation":"RULESET_REFRESH","reference":13,"status":"RUNNING","cancellable":false}]
Response
application/json
{
  "_pageInfo": {
    "numberOnPage": 0,
    "total": 0
  },
  "responseList": [
    { … }
  ]
}

Get asyncTask by ID

Request

Security
api_key
Path
asyncTaskIdinteger(int32)required

The ID of the asyncTask 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/async-tasks/{asyncTaskId}' \
  -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
}

Cancel asyncTask by ID

Request

Security
api_key
Path
asyncTaskIdinteger(int32)required

The ID of the asyncTask to cancel

curl -i -X PUT \
  'https://help-api.delphix.com/_mock/continuous-compliance-engine/2025.5.0.0/cc-engine-apis-2025.5.0.0/async-tasks/{asyncTaskId}/cancel' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Success

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