Skip to content
/
Create environment

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

Get all environments

Request

Security
api_key
Query
page_numberinteger(int64)

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

application_idinteger(int32)

The ID of the application to get all environments from

curl -i -X GET \
  'https://help-api.delphix.com/_mock/continuous-compliance-engine/2025.3.0.0/cc-engine-apis-2025.3.0.0/environments?page_number=1&page_size=0&application_id=0' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Success

Bodyapplication/json
_pageInfoobject(PageInfo)
responseListArray of objects(Environment)
Example: [{"environmentName":"test_env","applicationId":"1","purpose":"MASK"}]
Response
application/json
{
  "_pageInfo": {
    "numberOnPage": 0,
    "total": 0
  },
  "responseList": [
    { … }
  ]
}

Create environment

Request

Security
api_key
Bodyapplication/jsonrequired

The environment to create

environmentNamestring<= 255 charactersrequired

The name for this Environment. Note that it must be unique among Environments.

Example: "test_env"
applicationIdinteger(int32)required

The ID of the associated application.

Example: "1"
purposestringrequired

The purpose of this Environment. Environments with a 'MASK' purpose will have access to Masking and Profiling jobs, whereas Environments with a 'TOKENIZE' purpose will have access to Tokenization and Re-Identification jobs. Note that any custom purposes created through the UI will be represented as 'MASK' purposes, due to the jobs that they have access to.

Enum"MASK""TOKENIZE"
Example: "MASK"
isWorkflowEnabledboolean

True to have workflow enabled, false to leave the workflow disabled.

Default false
curl -i -X POST \
  https://help-api.delphix.com/_mock/continuous-compliance-engine/2025.3.0.0/cc-engine-apis-2025.3.0.0/environments \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "environmentName": "test_env",
    "applicationId": "1",
    "purpose": "MASK"
  }'

Responses

Success

Bodyapplication/json
environmentIdinteger(int32)read-only

The ID of the Environment. This field will be generated by the Masking Engine.

environmentNamestring<= 255 charactersrequired

The name for this Environment. Note that it must be unique among Environments.

Example: "test_env"
applicationIdinteger(int32)required

The ID of the associated application.

Example: "1"
applicationNamestringread-only

The Name of the associated application.

purposestringrequired

The purpose of this Environment. Environments with a 'MASK' purpose will have access to Masking and Profiling jobs, whereas Environments with a 'TOKENIZE' purpose will have access to Tokenization and Re-Identification jobs. Note that any custom purposes created through the UI will be represented as 'MASK' purposes, due to the jobs that they have access to.

Enum"MASK""TOKENIZE"
Example: "MASK"
isWorkflowEnabledboolean

True to have workflow enabled, false to leave the workflow disabled.

Default false
Response
application/json
{
  "environmentName": "test_env",
  "applicationId": "1",
  "purpose": "MASK"
}

Get environment by ID

Request

Security
api_key
Path
environmentIdinteger(int32)required

The ID of the environment 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/environments/{environmentId}' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Success

Bodyapplication/json
environmentIdinteger(int32)read-only

The ID of the Environment. This field will be generated by the Masking Engine.

environmentNamestring<= 255 charactersrequired

The name for this Environment. Note that it must be unique among Environments.

Example: "test_env"
applicationIdinteger(int32)required

The ID of the associated application.

Example: "1"
applicationNamestringread-only

The Name of the associated application.

purposestringrequired

The purpose of this Environment. Environments with a 'MASK' purpose will have access to Masking and Profiling jobs, whereas Environments with a 'TOKENIZE' purpose will have access to Tokenization and Re-Identification jobs. Note that any custom purposes created through the UI will be represented as 'MASK' purposes, due to the jobs that they have access to.

Enum"MASK""TOKENIZE"
Example: "MASK"
isWorkflowEnabledboolean

True to have workflow enabled, false to leave the workflow disabled.

Default false
Response
application/json
{
  "environmentName": "test_env",
  "applicationId": "1",
  "purpose": "MASK"
}

Update environment by ID

Request

Security
api_key
Path
environmentIdinteger(int32)required

The ID of the environment to update

Bodyapplication/jsonrequired

The updated environment

environmentNamestring<= 255 charactersrequired

The name for this Environment. Note that it must be unique among Environments.

Example: "test_env"
applicationIdinteger(int32)required

The ID of the associated application.

Example: "1"
purposestringrequired

The purpose of this Environment. Environments with a 'MASK' purpose will have access to Masking and Profiling jobs, whereas Environments with a 'TOKENIZE' purpose will have access to Tokenization and Re-Identification jobs. Note that any custom purposes created through the UI will be represented as 'MASK' purposes, due to the jobs that they have access to.

Enum"MASK""TOKENIZE"
Example: "MASK"
isWorkflowEnabledboolean

True to have workflow enabled, false to leave the workflow disabled.

Default false
curl -i -X PUT \
  'https://help-api.delphix.com/_mock/continuous-compliance-engine/2025.3.0.0/cc-engine-apis-2025.3.0.0/environments/{environmentId}' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "environmentName": "test_env",
    "applicationId": "1",
    "purpose": "MASK"
  }'

Responses

Success

Bodyapplication/json
environmentIdinteger(int32)read-only

The ID of the Environment. This field will be generated by the Masking Engine.

environmentNamestring<= 255 charactersrequired

The name for this Environment. Note that it must be unique among Environments.

Example: "test_env"
applicationIdinteger(int32)required

The ID of the associated application.

Example: "1"
applicationNamestringread-only

The Name of the associated application.

purposestringrequired

The purpose of this Environment. Environments with a 'MASK' purpose will have access to Masking and Profiling jobs, whereas Environments with a 'TOKENIZE' purpose will have access to Tokenization and Re-Identification jobs. Note that any custom purposes created through the UI will be represented as 'MASK' purposes, due to the jobs that they have access to.

Enum"MASK""TOKENIZE"
Example: "MASK"
isWorkflowEnabledboolean

True to have workflow enabled, false to leave the workflow disabled.

Default false
Response
application/json
{
  "environmentName": "test_env",
  "applicationId": "1",
  "purpose": "MASK"
}

Delete environment by ID

Request

Security
api_key
Path
environmentIdinteger(int32)required

The ID of the environment 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/environments/{environmentId}' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Success

Copy environment by ID

Request

Security
api_key
Path
environmentIdinteger(int32)required

The ID of the environment to copy

Bodyapplication/jsonrequired

The environment to create

environmentNamestring<= 255 charactersrequired

The name for this Environment. Note that it must be unique among Environments.

Example: "test_env"
applicationIdinteger(int32)required

The ID of the associated application.

Example: "1"
purposestringrequired

The purpose of this Environment. Environments with a 'MASK' purpose will have access to Masking and Profiling jobs, whereas Environments with a 'TOKENIZE' purpose will have access to Tokenization and Re-Identification jobs. Note that any custom purposes created through the UI will be represented as 'MASK' purposes, due to the jobs that they have access to.

Enum"MASK""TOKENIZE"
Example: "MASK"
isWorkflowEnabledboolean

True to have workflow enabled, false to leave the workflow disabled.

Default false
curl -i -X POST \
  'https://help-api.delphix.com/_mock/continuous-compliance-engine/2025.3.0.0/cc-engine-apis-2025.3.0.0/environments/{environmentId}/copy' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "environmentName": "test_env",
    "applicationId": "1",
    "purpose": "MASK"
  }'

Responses

Success

Bodyapplication/json
environmentIdinteger(int32)read-only

The ID of the Environment. This field will be generated by the Masking Engine.

environmentNamestring<= 255 charactersrequired

The name for this Environment. Note that it must be unique among Environments.

Example: "test_env"
applicationIdinteger(int32)required

The ID of the associated application.

Example: "1"
applicationNamestringread-only

The Name of the associated application.

purposestringrequired

The purpose of this Environment. Environments with a 'MASK' purpose will have access to Masking and Profiling jobs, whereas Environments with a 'TOKENIZE' purpose will have access to Tokenization and Re-Identification jobs. Note that any custom purposes created through the UI will be represented as 'MASK' purposes, due to the jobs that they have access to.

Enum"MASK""TOKENIZE"
Example: "MASK"
isWorkflowEnabledboolean

True to have workflow enabled, false to leave the workflow disabled.

Default false
Response
application/json
{
  "environmentName": "test_env",
  "applicationId": "1",
  "purpose": "MASK"
}

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