Skip to content

Retrieve a MaskingEnvironment by ID.

Request

Security
ApiKeyAuth
Path
maskingEnvironmentIdstring, non-emptyrequired

The ID of the Masking Environment.

curl -i -X GET \
  'https://help-api.delphix.com/_mock/data-control-tower/continuous-compliance/23.0.0/continuous-compliance-apis-dct-23.0.0/masking-environments/{maskingEnvironmentId}' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

OK

Bodyapplication/json
idstring

The MaskingEnvironment entity ID.

Example:"masking-environment-1"
engine_idstring

The ID of the Engine where this MaskingEnvironment resides.

Example:"engine-123"
engine_namestring

The name of the Engine where this MaskingEnvironment resides.

Example:"engine-xyz"
namestring

The name of this MaskingEnvironment.

Example:"MyAppEnvironment"
purposestring

The purpose of this MaskingEnvironment. MaskingEnvironments 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"
is_workflow_enabledboolean
Response
{ "id": "masking-environment-1", "engine_id": "engine-123", "engine_name": "engine-xyz", "name": "MyAppEnvironment", "purpose": "MASK", "is_workflow_enabled": true }