Skip to content
/
Get all file rulesets

Masking API (5.1.41)

Schema for the Continuous Compliance Engine API

Download OpenAPI description
CC Engine APIs (2025.1.0.0).json
CC Engine APIs (2025.1.0.0).yaml
Languages
Servers
Mock server
https://help-api.delphix.com/_mock/continuous-compliance-engine/2025.1.0.0/cc-engine-apis-2025.1.0.0
https://help-api.delphix.com/masking/api/v5.1.41

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

Get all file rulesets

Request

Security
api_key
Query
environment_idinteger(int32)

The ID of the environment to get all file rulesets from

page_numberinteger(int64)

The page number for which to get file 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.1.0.0/cc-engine-apis-2025.1.0.0/file-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(FileRuleset)
Example: [{"rulesetName":"Rule123","fileConnectorId":1}]
Response
application/json
{
  "_pageInfo": {
    "numberOnPage": 0,
    "total": 0
  },
  "responseList": [
    { … }
  ]
}

Create file ruleset

Request

Security
api_key
Bodyapplication/jsonrequired

The file ruleset to create

rulesetNamestring<= 255 charactersrequired

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

Example: "Rule123"
fileConnectorIdinteger(int32)required

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

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

Responses

Success

Bodyapplication/json
fileRulesetIdinteger(int32)read-only

The ID of the file 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"
fileConnectorIdinteger(int32)required

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

Example: 1
Response
application/json
{
  "rulesetName": "Rule123",
  "fileConnectorId": 1
}

Get file ruleset by ID

Request

Security
api_key
Path
fileRulesetIdinteger(int32)required

The ID of the file ruleset to get

curl -i -X GET \
  'https://help-api.delphix.com/_mock/continuous-compliance-engine/2025.1.0.0/cc-engine-apis-2025.1.0.0/file-rulesets/{fileRulesetId}' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Success

Bodyapplication/json
fileRulesetIdinteger(int32)read-only

The ID of the file 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"
fileConnectorIdinteger(int32)required

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

Example: 1
Response
application/json
{
  "rulesetName": "Rule123",
  "fileConnectorId": 1
}

Delete file ruleset by ID

Request

Security
api_key
Path
fileRulesetIdinteger(int32)required

The ID of the file ruleset to delete

curl -i -X DELETE \
  'https://help-api.delphix.com/_mock/continuous-compliance-engine/2025.1.0.0/cc-engine-apis-2025.1.0.0/file-rulesets/{fileRulesetId}' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Success

Update the set of files and their attributes associated with a file ruleset in bulk

Request

Security
api_key
Path
fileRulesetIdinteger(int32)required

The ID of the file ruleset to update the file for

Bodyapplication/jsonrequired

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

fileMetadataArray of objects(FileMetadata)required
Example: [{"fileName":"file.delimited","rulesetId":1,"fileFormatId":2,"delimiter":"*","endOfRecord":"\n"}]
fileMetadata[].​rulesetIdinteger(int32)required

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

Example: 1
fileMetadata[].​fileFormatIdinteger(int32)

The ID of the file format corresponding to this file. It is used to determine the fields for this file. This field is required.

Example: 2
fileMetadata[].​delimiterstring<= 50 characters

The delimiter for a delimited file. This field should be left blank for other file types.

Example: "*"
fileMetadata[].​enclosurestring<= 5 characters

The text enclosure for the file.

fileMetadata[].​enclosureEscapeCharacterstring

The character used to escape a literal enclosure character within an enclosed value. By default, this is equal to the enclosure value itself, so doubling the enclosure character escape it.

fileMetadata[].​escapeEnclosureEscapeCharacterboolean

This flag indicates whether the enclosure escape character also escapes itself. For example, if the enclosure escape character is *, then the sequence ** would be treated as a single * character, rather than an escape.

Default false
fileMetadata[].​endOfRecordstring<= 25 characters

The string of characters that delineates the end-of-record for a file. Note that, for linux this is '\n', and for windows it is '\r\n'.

Example: "\n"
fileMetadata[].​nameIsRegularExpressionboolean

Whether or not this file name represents a regular expression.

Default false
fileMetadata[].​wholeFileMaskingboolean

This flag indicates whether the file is to be read as whole or line-by-line (Only for FIXED_WIDTH file type). For example, if the whole file masking is true, then the whole file will be read as a single record, rather than reading it line by line.

Default false
curl -i -X PUT \
  'https://help-api.delphix.com/_mock/continuous-compliance-engine/2025.1.0.0/cc-engine-apis-2025.1.0.0/file-rulesets/{fileRulesetId}/bulk-file-update' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "fileMetadata": [
      {
        "fileName": "file.delimited",
        "rulesetId": 1,
        "fileFormatId": 2,
        "delimiter": "*",
        "endOfRecord": "\n"
      }
    ]
  }'

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 file ruleset by ID

Request

Security
api_key
Path
fileRulesetIdinteger(int32)required

The ID of the file 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.1.0.0/cc-engine-apis-2025.1.0.0/file-rulesets/{fileRulesetId}/copy' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "newRulesetName": "Rule123"
  }'

Responses

Success

Bodyapplication/json
fileRulesetIdinteger(int32)read-only

The ID of the file 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"
fileConnectorIdinteger(int32)required

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

Example: 1
Response
application/json
{
  "rulesetName": "Rule123",
  "fileConnectorId": 1
}

Export file ruleset by ID

Request

Security
api_key
Path
fileRulesetIdinteger(int32)required

The ID of the file ruleset to export

Bodyapplication/jsonrequired

The name of the exported file

exportFileNamestring<= 50 charactersrequired

The name of the exported ruleset CSV file.

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

Responses

Success

Bodyapplication/json
exportFileNamestring<= 50 charactersrequired

The name of the exported ruleset CSV file.

Example: "my-delimited-file-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-delimited-file-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
fileRulesetIdinteger(int32)required

The ID of the file rule-set to import

Bodymultipart/form-datarequired
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.1.0.0/cc-engine-apis-2025.1.0.0/file-rulesets/{fileRulesetId}/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"
  ]
}

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