Skip to content
/
Create database ruleset

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

columnMetadata

Operations

credentialPath

Operations

configuration

Operations

databaseConnector

Operations

databaseRuleset

Operations

Get all database rulesets

Request

Security
api_key
Query
environment_idinteger(int32)

The ID of the environment to get all database rulesets from

page_numberinteger(int64)

The page number for which to get database rulesets. 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/database-rulesets?environment_id=0&page_number=1&page_size=0' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Success

Bodyapplication/json
_pageInfoobject(PageInfo)
responseListArray of objects(DatabaseRuleset)
Example: [{"rulesetName":"Rule123","databaseConnectorId":1}]
Response
application/json
{
  "_pageInfo": {
    "numberOnPage": 0,
    "total": 0
  },
  "responseList": [
    { … }
  ]
}

Create database ruleset

Request

Security
api_key
Bodyapplication/jsonrequired

The database ruleset to create

rulesetNamestring<= 255 charactersrequired

The name of the ruleset. This must be unique within an environment.

Example: "Rule123"
databaseConnectorIdinteger(int32)required

The ID of the database connector that this ruleset corresponds to. Note that the ruleset will be created on the same environment as its connector.

Example: 1
refreshDropsTablesboolean

This field applies to the case where a Table Metadata exists in the Masking Engine, but the corresponding table no longer exists in the external database (e.g. if the table has been deleted or renamed). In that event, True will cause the refresh operation to delete the invalid Table Metadata, whereas False will fail the refresh instead.

Default false
curl -i -X POST \
  https://help-api.delphix.com/_mock/continuous-compliance-engine/2025.5.0.0/cc-engine-apis-2025.5.0.0/database-rulesets \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "rulesetName": "Rule123",
    "databaseConnectorId": 1
  }'

Responses

Success

Bodyapplication/json
databaseRulesetIdinteger(int32)read-only

The ID of the database ruleset. This field is set by the Masking Engine.

rulesetNamestring<= 255 charactersrequired

The name of the ruleset. This must be unique within an environment.

Example: "Rule123"
databaseConnectorIdinteger(int32)required

The ID of the database connector that this ruleset corresponds to. Note that the ruleset will be created on the same environment as its connector.

Example: 1
refreshDropsTablesboolean

This field applies to the case where a Table Metadata exists in the Masking Engine, but the corresponding table no longer exists in the external database (e.g. if the table has been deleted or renamed). In that event, True will cause the refresh operation to delete the invalid Table Metadata, whereas False will fail the refresh instead.

Default false
Response
application/json
{
  "rulesetName": "Rule123",
  "databaseConnectorId": 1
}

Get database ruleset by ID

Request

Security
api_key
Path
databaseRulesetIdinteger(int32)required

The ID of the database ruleset 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/database-rulesets/{databaseRulesetId}' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Success

Bodyapplication/json
databaseRulesetIdinteger(int32)read-only

The ID of the database ruleset. This field is set by the Masking Engine.

rulesetNamestring<= 255 charactersrequired

The name of the ruleset. This must be unique within an environment.

Example: "Rule123"
databaseConnectorIdinteger(int32)required

The ID of the database connector that this ruleset corresponds to. Note that the ruleset will be created on the same environment as its connector.

Example: 1
refreshDropsTablesboolean

This field applies to the case where a Table Metadata exists in the Masking Engine, but the corresponding table no longer exists in the external database (e.g. if the table has been deleted or renamed). In that event, True will cause the refresh operation to delete the invalid Table Metadata, whereas False will fail the refresh instead.

Default false
Response
application/json
{
  "rulesetName": "Rule123",
  "databaseConnectorId": 1
}

Update database ruleset

Request

Security
api_key
Path
databaseRulesetIdinteger(int32)required

The ID of the database ruleset to update

Bodyapplication/jsonrequired

The updated form of the database ruleset

rulesetNamestring<= 255 charactersrequired

The name of the ruleset. This must be unique within an environment.

Example: "Rule123"
databaseConnectorIdinteger(int32)required

The ID of the database connector that this ruleset corresponds to. Note that the ruleset will be created on the same environment as its connector.

Example: 1
refreshDropsTablesboolean

This field applies to the case where a Table Metadata exists in the Masking Engine, but the corresponding table no longer exists in the external database (e.g. if the table has been deleted or renamed). In that event, True will cause the refresh operation to delete the invalid Table Metadata, whereas False will fail the refresh instead.

Default false
curl -i -X PUT \
  'https://help-api.delphix.com/_mock/continuous-compliance-engine/2025.5.0.0/cc-engine-apis-2025.5.0.0/database-rulesets/{databaseRulesetId}' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "rulesetName": "Rule123",
    "databaseConnectorId": 1
  }'

Responses

Success

Bodyapplication/json
databaseRulesetIdinteger(int32)read-only

The ID of the database ruleset. This field is set by the Masking Engine.

rulesetNamestring<= 255 charactersrequired

The name of the ruleset. This must be unique within an environment.

Example: "Rule123"
databaseConnectorIdinteger(int32)required

The ID of the database connector that this ruleset corresponds to. Note that the ruleset will be created on the same environment as its connector.

Example: 1
refreshDropsTablesboolean

This field applies to the case where a Table Metadata exists in the Masking Engine, but the corresponding table no longer exists in the external database (e.g. if the table has been deleted or renamed). In that event, True will cause the refresh operation to delete the invalid Table Metadata, whereas False will fail the refresh instead.

Default false
Response
application/json
{
  "rulesetName": "Rule123",
  "databaseConnectorId": 1
}

Delete database ruleset by ID

Request

Security
api_key
Path
databaseRulesetIdinteger(int32)required

The ID of the database ruleset 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/database-rulesets/{databaseRulesetId}' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Success

Update the set of tables and their attributes associated with a database ruleset in bulk

Request

Security
api_key
Path
databaseRulesetIdinteger(int32)required

The ID of the database ruleset to update the tables for

Bodyapplication/jsonrequired

The exact list of tables to put in the ruleset. Note that existing tables for this ruleset not in this list will be deleted

tableMetadataArray of objects(TableMetadata)required
Example: [{"tableName":"profile","rulesetId":2},{"tableName":"address","rulesetId":2},{"tableName":"users","rulesetId":2}]
tableMetadata[].​tableNamestring<= 240 charactersrequired

The name of the table metadata. This name must match the name of a table in the ruleset it is created on. This name must be unique for the given ruleset; in other words, the same table cannot be added to a ruleset more than once.

Example: "profile"
tableMetadata[].​rulesetIdinteger(int32)required

The ID of the ruleset to create the table metadata on.

Example: 1
tableMetadata[].​customSqlstring

Custom SQL for the table.

tableMetadata[].​whereClausestring<= 5000 characters

SQL where clause for the table.

tableMetadata[].​havingClausestring<= 200 characters

SQL having clause for the table.

tableMetadata[].​keyColumnstring<= 1024 characters

Key Column for the table.

curl -i -X PUT \
  'https://help-api.delphix.com/_mock/continuous-compliance-engine/2025.5.0.0/cc-engine-apis-2025.5.0.0/database-rulesets/{databaseRulesetId}/bulk-table-update' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "tableMetadata": [
      {
        "tableName": "profile",
        "rulesetId": 2
      },
      {
        "tableName": "address",
        "rulesetId": 2
      },
      {
        "tableName": "users",
        "rulesetId": 2
      }
    ]
  }'

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
}

Refresh database ruleset by ID

Request

Security
api_key
Path
databaseRulesetIdinteger(int32)required

The ID of the database ruleset to refresh

curl -i -X PUT \
  'https://help-api.delphix.com/_mock/continuous-compliance-engine/2025.5.0.0/cc-engine-apis-2025.5.0.0/database-rulesets/{databaseRulesetId}/refresh' \
  -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
}

Copy database ruleset by ID

Request

Security
api_key
Path
databaseRulesetIdinteger(int32)required

The ID of the database ruleset to copy

Bodyapplication/jsonrequired

The name of the ruleset. This must be unique within an environment.

newRulesetNamestring<= 255 charactersrequired

The name of the ruleset. This must be unique within an environment.

Example: "Rule123"
curl -i -X PUT \
  'https://help-api.delphix.com/_mock/continuous-compliance-engine/2025.5.0.0/cc-engine-apis-2025.5.0.0/database-rulesets/{databaseRulesetId}/copy' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "newRulesetName": "Rule123"
  }'

Responses

Success

Bodyapplication/json
databaseRulesetIdinteger(int32)read-only

The ID of the database ruleset. This field is set by the Masking Engine.

rulesetNamestring<= 255 charactersrequired

The name of the ruleset. This must be unique within an environment.

Example: "Rule123"
databaseConnectorIdinteger(int32)required

The ID of the database connector that this ruleset corresponds to. Note that the ruleset will be created on the same environment as its connector.

Example: 1
refreshDropsTablesboolean

This field applies to the case where a Table Metadata exists in the Masking Engine, but the corresponding table no longer exists in the external database (e.g. if the table has been deleted or renamed). In that event, True will cause the refresh operation to delete the invalid Table Metadata, whereas False will fail the refresh instead.

Default false
Response
application/json
{
  "rulesetName": "Rule123",
  "databaseConnectorId": 1
}

Export database Ruleset inventory by ID

Request

Security
api_key
Path
databaseRulesetIdinteger(int32)required

The ID of the database ruleset to import

Bodyapplication/jsonrequired

The name of the exported file

exportFileNamestring<= 50 charactersrequired

The name of the exported ruleset CSV file.

Example: "my-database-ruleset.csv"
curl -i -X POST \
  'https://help-api.delphix.com/_mock/continuous-compliance-engine/2025.5.0.0/cc-engine-apis-2025.5.0.0/database-rulesets/{databaseRulesetId}/csvExport' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "exportFileName": "my-database-ruleset.csv"
  }'

Responses

Success

Bodyapplication/json
exportFileNamestring<= 50 charactersrequired

The name of the exported ruleset CSV file.

Example: "my-database-ruleset.csv"
fileReferenceIdstringread-only

The reference URI of the exported ruleset file. Use this reference id in file download api to download the exported file.

Response
application/json
{
  "exportFileName": "my-database-ruleset.csv"
}

Import Ruleset inventory from CSV file

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
Path
databaseRulesetIdinteger(int32)required

The ID of the database ruleset to import

Bodymultipart/form-datarequired

The name of the ruleset. This must be unique within an environment.

filestring(binary)required

The rule-set exported CSV file to be imported.

curl -i -X PUT \
  'https://help-api.delphix.com/_mock/continuous-compliance-engine/2025.5.0.0/cc-engine-apis-2025.5.0.0/database-rulesets/{databaseRulesetId}/csvImport' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: multipart/form-data' \
  -F file=string

Responses

Success

Bodyapplication/json
importStatusstringread-only
Enum"SUCCESS""FAILED""WARNING"
Example: "SUCCESS"
messageArray of stringsread-only
Example: ["Inventory imported successfully"]
Response
application/json
{
  "importStatus": "SUCCESS",
  "message": [
    "Inventory imported successfully"
  ]
}

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