Skip to content
/
Get all application setti...

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

Get all application settings

Request

Security
api_key
Query
setting_groupstring

The group of the setting

page_numberinteger(int64)

The page number for which to get application settings. 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/application-settings?setting_group=string&page_number=1&page_size=0' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Success

Bodyapplication/json
_pageInfoobject(PageInfo)
responseListArray of objects(ApplicationSettings)
Example: [{"settingValue":"true"}]
Response
application/json
{
  "_pageInfo": {
    "numberOnPage": 0,
    "total": 0
  },
  "responseList": [
    { … }
  ]
}

Get application setting by ID

Request

Security
api_key
Path
settingIdinteger(int32)required

The ID of the setting

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

Responses

Success

Bodyapplication/json
settingIdinteger(int32)read-only

The ID of the application setting

settingGroupstring<= 255 charactersread-only

Application setting group

settingNamestring<= 255 charactersread-only

Application setting available per group

settingValuestring<= 255 charactersrequired

Value for an application setting

Example: "true"
valueTypestringread-only

Type of the value

Enum"string""boolean""number""regular-expression"
Response
application/json
{
  "settingValue": "true"
}

Update application setting by ID

Request

Security
api_key
Path
settingIdinteger(int32)required

The ID of the setting

Bodyapplication/jsonrequired

The updated application setting

settingValuestring<= 255 charactersrequired

Value for an application setting

Example: "true"
curl -i -X PUT \
  'https://help-api.delphix.com/_mock/continuous-compliance-engine/2025.3.0.0/cc-engine-apis-2025.3.0.0/application-settings/{settingId}' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "settingValue": "true"
  }'

Responses

Success

Bodyapplication/json
settingIdinteger(int32)read-only

The ID of the application setting

settingGroupstring<= 255 charactersread-only

Application setting group

settingNamestring<= 255 charactersread-only

Application setting available per group

settingValuestring<= 255 charactersrequired

Value for an application setting

Example: "true"
valueTypestringread-only

Type of the value

Enum"string""boolean""number""regular-expression"
Response
application/json
{
  "settingValue": "true"
}

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

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