Skip to content

Masking API (5.1.43)

Schema for the Continuous Compliance Engine API

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

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

Get all files

Request

Security
api_key
Query
permanentboolean

This indicates whether the file should be persisted permanently. Note that this should be set to true for files like an OAuth settings file, i.e., files that are not explicitly referenced by a JDBC driver, algorithm or driver support plugin, or connection properties file.

Default false
page_numberinteger(int64)

The page number for which to get algorithms. 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.3.0.0/cc-engine-apis-2025.3.0.0/file-uploads?permanent=false&page_number=1&page_size=0' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Success

Bodyapplication/json
_pageInfoobject(PageInfo)
responseListArray of objects(FileUpload)
Example: [{"fileReferenceId":"delphix-file://upload/f_08bb469a2ddc407bb97a31e96ed0a76a/foo.bar"}]
Response
application/json
{
  "_pageInfo": {
    "numberOnPage": 0,
    "total": 0
  },
  "responseList": [
    { … }
  ]
}

Upload 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
Query
permanentboolean

This indicates whether the file should be persisted permanently. Note that this should be set to true for files like an OAuth settings file, i.e., files that are not explicitly referenced by a JDBC driver, algorithm or driver support plugin, or connection properties file.

Default false
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.3.0.0/cc-engine-apis-2025.3.0.0/file-uploads?permanent=false' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: multipart/form-data' \
  -F file=string

Responses

Success

Bodyapplication/json
fileUuidstringread-only

The unique identifier of the uploaded file. This field is auto-generated by the Masking Engine. This field applies to permanently uploaded files only and can be used to update and delete a permanent file by its ID.

fileReferenceIdstringread-only

The reference URI of the uploaded file.

Example: "delphix-file://upload/f_08bb469a2ddc407bb97a31e96ed0a76a/foo.bar"
filenamestringread-only

The name of the file.

fileSizenumberread-only

The size in B (bytes) of the uploaded file.

persistenceTypestring

The type of persistence of the uploaded file. Temporary/object indicates that the file was either uploaded as a temporary file or as a file associated with a masking object, like a JDBC driver or algorithm plugin.

Enum"PERMANENT""OBJECT/TEMPORARY"
Response
application/json
{
  "fileReferenceId": "delphix-file://upload/f_08bb469a2ddc407bb97a31e96ed0a76a/foo.bar"
}

Delete all files

Request

Security
api_key
Query
permanentboolean

This indicates whether all of the files that should be deleted are in the permanent upload directory. This defaults to false so all of the files that are deleted are in the temporary upload directory.

Default false
curl -i -X DELETE \
  'https://help-api.delphix.com/_mock/continuous-compliance-engine/2025.3.0.0/cc-engine-apis-2025.3.0.0/file-uploads?permanent=false' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Success

Get file upload by ID

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
fileUuidstringrequired

The unique identifier of the permanently uploaded file to get

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

Responses

Success

Bodyapplication/json
fileUuidstringread-only

The unique identifier of the uploaded file. This field is auto-generated by the Masking Engine. This field applies to permanently uploaded files only and can be used to update and delete a permanent file by its ID.

fileReferenceIdstringread-only

The reference URI of the uploaded file.

Example: "delphix-file://upload/f_08bb469a2ddc407bb97a31e96ed0a76a/foo.bar"
filenamestringread-only

The name of the file.

fileSizenumberread-only

The size in B (bytes) of the uploaded file.

persistenceTypestring

The type of persistence of the uploaded file. Temporary/object indicates that the file was either uploaded as a temporary file or as a file associated with a masking object, like a JDBC driver or algorithm plugin.

Enum"PERMANENT""OBJECT/TEMPORARY"
Response
application/json
{
  "fileReferenceId": "delphix-file://upload/f_08bb469a2ddc407bb97a31e96ed0a76a/foo.bar"
}

Update permanent file upload by ID

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
fileUuidstringrequired

The unique identifier of the permanently uploaded file to update

Bodymultipart/form-datarequired
filestring(binary)required

The file to be uploaded.

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

Responses

Success

Bodyapplication/json
fileUuidstringread-only

The unique identifier of the uploaded file. This field is auto-generated by the Masking Engine. This field applies to permanently uploaded files only and can be used to update and delete a permanent file by its ID.

fileReferenceIdstringread-only

The reference URI of the uploaded file.

Example: "delphix-file://upload/f_08bb469a2ddc407bb97a31e96ed0a76a/foo.bar"
filenamestringread-only

The name of the file.

fileSizenumberread-only

The size in B (bytes) of the uploaded file.

persistenceTypestring

The type of persistence of the uploaded file. Temporary/object indicates that the file was either uploaded as a temporary file or as a file associated with a masking object, like a JDBC driver or algorithm plugin.

Enum"PERMANENT""OBJECT/TEMPORARY"
Response
application/json
{
  "fileReferenceId": "delphix-file://upload/f_08bb469a2ddc407bb97a31e96ed0a76a/foo.bar"
}

Delete permanent file upload by ID

Request

Security
api_key
Path
fileUuidstringrequired

The unique identifier of the permanently uploaded file to delete

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

Responses

Success

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