environment

Get all environments

Securityapi_key
Request
query Parameters
page_number
integer <int64>
Default: 1

The page number for which to get environments. This will default to the first page if excluded

page_size
integer <int64>

The maximum number of objects to return. This will default to the DefaultApiPageSize setting if not provided

application_id
integer <int32>

The ID of the application to get all environments from

Responses
200

Success

400

Bad request

403

Forbidden access

get/environments
Response samples
application/json
{
  • "_pageInfo": {
    },
  • "responseList": [
    ]
}

Create environment

Securityapi_key
Request
Request Body schema: application/json
required

The environment to create

environmentName
required
string <= 255 characters

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

applicationId
required
integer <int32>

The ID of the associated application.

purpose
required
string

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"
isWorkflowEnabled
boolean
Default: false

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

Responses
201

Success

400

Bad request

403

Forbidden access

404

Not found

409

Conflict

post/environments
Request samples
application/json
{
  • "environmentName": "test_env",
  • "applicationId": "1",
  • "purpose": "MASK"
}
Response samples
application/json
{
  • "environmentName": "test_env",
  • "applicationId": "1",
  • "purpose": "MASK"
}

Get environment by ID

Securityapi_key
Request
path Parameters
environmentId
required
integer <int32>

The ID of the environment to get

Responses
200

Success

403

Forbidden access

404

Not found

get/environments/{environmentId}
Response samples
application/json
{
  • "environmentName": "test_env",
  • "applicationId": "1",
  • "purpose": "MASK"
}

Update environment by ID

Securityapi_key
Request
path Parameters
environmentId
required
integer <int32>

The ID of the environment to update

Request Body schema: application/json
required

The updated environment

environmentName
required
string <= 255 characters

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

applicationId
required
integer <int32>

The ID of the associated application.

purpose
required
string

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"
isWorkflowEnabled
boolean
Default: false

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

Responses
200

Success

400

Bad request

403

Forbidden access

404

Not found

409

Conflict

put/environments/{environmentId}
Request samples
application/json
{
  • "environmentName": "test_env",
  • "applicationId": "1",
  • "purpose": "MASK"
}
Response samples
application/json
{
  • "environmentName": "test_env",
  • "applicationId": "1",
  • "purpose": "MASK"
}

Delete environment by ID

Securityapi_key
Request
path Parameters
environmentId
required
integer <int32>

The ID of the environment to delete

Responses
200

Success

400

Bad request

403

Forbidden access

404

Not found

409

Conflict

delete/environments/{environmentId}

Copy environment by ID

Securityapi_key
Request
path Parameters
environmentId
required
integer <int32>

The ID of the environment to copy

Request Body schema: application/json
required

The environment to create

environmentName
required
string <= 255 characters

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

applicationId
required
integer <int32>

The ID of the associated application.

purpose
required
string

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"
isWorkflowEnabled
boolean
Default: false

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

Responses
200

Success

400

Bad request

403

Forbidden access

404

Not found

post/environments/{environmentId}/copy
Request samples
application/json
{
  • "environmentName": "test_env",
  • "applicationId": "1",
  • "purpose": "MASK"
}
Response samples
application/json
{
  • "environmentName": "test_env",
  • "applicationId": "1",
  • "purpose": "MASK"
}
➔ Next to execution