Skip to content
/
Import masking objects

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

Export masking object

Request

Export masking objects

Security
api_key
Bodyapplication/jsonrequired

The identifier for the masking object to export

Array [
objectIdentifierobjectrequired
objectTypestringrequired

Type of object to export

Enum"ALGORITHM_PLUGIN""ALGORITHM_REFERENCE""APPLICATION_SETTINGS""BINARYLOOKUP""CLASSIFIER""CLASSIFIER_REFERENCE""CLEANSING""CREDENTIAL_PATH""DATABASE_CONNECTOR""DATABASE_RULESET"
revisionHashstring

Global comparison value for the syncable object that gets recalculated upon update to any object along its dependency chain

revisionIdstring

Global ID for the syncable object that gets recalculated only upon update to its own object

]
curl -i -X POST \
  https://help-api.delphix.com/_mock/continuous-compliance-engine/2025.2.0.0/cc-engine-apis-2025.2.0.0/export \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '[
    {
      "objectIdentifier": {},
      "objectType": "ALGORITHM_PLUGIN",
      "revisionHash": "string",
      "revisionId": "string"
    }
  ]'

Responses

Success

Bodyapplication/json
exportResponseMetadataobjectrequired
blobstringrequired

Export package containing data representing masking object

signaturestringrequired

Cryptographic signature of the blob

publicKeystringrequired

Public version of the key used to generate the signature

Response
application/json
{
  "exportResponseMetadata": {},
  "blob": "string",
  "signature": "string",
  "publicKey": "string"
}

Export masking object

Request

Export masking objects

Security
api_key
Query
structurestring

The structure of the resulting export bundle.

Enum"ZIP""BLOB"
Bodyapplication/jsonrequired

The identifier for the masking object to export

Array [
objectIdentifierobjectrequired
objectTypestringrequired

Type of object to export

Enum"ALGORITHM_PLUGIN""ALGORITHM_REFERENCE""APPLICATION_SETTINGS""BINARYLOOKUP""CLASSIFIER""CLASSIFIER_REFERENCE""CLEANSING""CREDENTIAL_PATH""DATABASE_CONNECTOR""DATABASE_RULESET"
revisionHashstring

Global comparison value for the syncable object that gets recalculated upon update to any object along its dependency chain

revisionIdstring

Global ID for the syncable object that gets recalculated only upon update to its own object

]
curl -i -X POST \
  'https://help-api.delphix.com/_mock/continuous-compliance-engine/2025.2.0.0/cc-engine-apis-2025.2.0.0/export-async?structure=ZIP' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '[
    {
      "objectIdentifier": {},
      "objectType": "ALGORITHM_PLUGIN",
      "revisionHash": "string",
      "revisionId": "string"
    }
  ]'

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 all export documents from /async-export tasks

Request

Security
api_key
curl -i -X DELETE \
  https://help-api.delphix.com/_mock/continuous-compliance-engine/2025.2.0.0/cc-engine-apis-2025.2.0.0/export-async \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Success

Import masking objects

Request

Import masking objects

Security
api_key
Query
force_overwritebooleanrequired

Specify whether the import should fail if an object already exists with the same ID or the existing object should be overwritten.

environment_idinteger(int32)

The ID of the environment to import objects into

source_environment_idinteger(int32)

The ID of the source environment to import on-the-fly connectors into

Bodyapplication/jsonrequired

The identifier for the masking object to import

exportResponseMetadataobjectrequired
blobstringrequired

Export package containing data representing masking object

signaturestringrequired

Cryptographic signature of the blob

publicKeystringrequired

Public version of the key used to generate the signature

curl -i -X POST \
  'https://help-api.delphix.com/_mock/continuous-compliance-engine/2025.2.0.0/cc-engine-apis-2025.2.0.0/import?force_overwrite=true&environment_id=0&source_environment_id=0' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "exportResponseMetadata": {},
    "blob": "string",
    "signature": "string",
    "publicKey": "string"
  }'

Responses

Success

Bodyapplication/jsonArray [
objectIdentifierobjectrequired

Identifier of the imported object on the engine where it was exported from.

importedObjectIdentifierobject

Identifier of the imported object on this engine.

objectTypestringrequired

Type of object to export

Enum"ALGORITHM_PLUGIN""ALGORITHM_REFERENCE""APPLICATION_SETTINGS""BINARYLOOKUP""CLASSIFIER""CLASSIFIER_REFERENCE""CLEANSING""CREDENTIAL_PATH""DATABASE_CONNECTOR""DATABASE_RULESET"
importStatusstringread-only
Enum"SUCCESS""FAILED""SKIPPED"
failureMessagestringread-only
]
Response
application/json
[
  {
    "objectIdentifier": {},
    "importedObjectIdentifier": {},
    "objectType": "ALGORITHM_PLUGIN",
    "importStatus": "SUCCESS",
    "failureMessage": "string"
  }
]

Import masking objects

Request

WARNING: The generated curl command is incorrect, so please refer to the Masking API guide for instructions on how to upload files through the API

Security
api_key
Query
force_overwritebooleanrequired

Specify whether the import should fail if an object already exists with the same ID or the existing object should be overwritten.

environment_idinteger(int32)

The ID of the environment to import objects into

source_environment_idinteger(int32)

The ID of the source environment to import on-the-fly connectors into

Bodymultipart/form-datarequired
filestring(binary)required

The file to be uploaded.

curl -i -X POST \
  'https://help-api.delphix.com/_mock/continuous-compliance-engine/2025.2.0.0/cc-engine-apis-2025.2.0.0/import-async?force_overwrite=true&environment_id=0&source_environment_id=0' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: multipart/form-data' \
  -F file=string

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 all import documents from /async-import tasks

Request

Security
api_key
curl -i -X DELETE \
  https://help-api.delphix.com/_mock/continuous-compliance-engine/2025.2.0.0/cc-engine-apis-2025.2.0.0/import-async \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Success

Get all syncable objects

Request

Get all syncable objects

Security
api_key
Query
page_numberinteger(int64)

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

object_typestring

The type of syncable object to filter for

Enum"ALGORITHM_PLUGIN""APPLICATION_SETTINGS""CLASSIFIER""CREDENTIAL_PATH""DATABASE_CONNECTOR""DATABASE_RULESET""DATASET_CONNECTOR""DATASET_RULESET""DATASET_FORMAT""DOMAIN"
curl -i -X GET \
  'https://help-api.delphix.com/_mock/continuous-compliance-engine/2025.2.0.0/cc-engine-apis-2025.2.0.0/syncable-objects?page_number=1&page_size=0&object_type=ALGORITHM_PLUGIN' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Success

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

Get syncable object for environment

Request

Get syncable object for environment

Security
api_key
Path
environmentIdinteger(int32)required

The ID of the environment to retrieve syncable object of

curl -i -X GET \
  'https://help-api.delphix.com/_mock/continuous-compliance-engine/2025.2.0.0/cc-engine-apis-2025.2.0.0/syncable-objects/environments/{environmentId}' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Success

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

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