Skip to content
/
Get all credential paths

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

Get all credential paths

Request

Security
api_key
Query
page_numberinteger(int64)

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

Responses

Success

Bodyapplication/json
_pageInfoobject(PageInfo)
responseListArray of objects(CredentialPath)
Example: [{"credentialPathName":"ExampleCredentialPath","description":"This CredentialPath example has HashiCorp credentialParameters. Example credentialParameter keys for other password vaults: CyberArk (queryString), GCP (versionId, projectId, usernameKey, passwordKey)","passwordVaultId":5,"credentialParameters":{"engine":"my-secrets","path":"hello","usernameKey":"user","passwordKey":"pwd"}}]
Response
application/json
{
  "_pageInfo": {
    "numberOnPage": 0,
    "total": 0
  },
  "responseList": [
    { … }
  ]
}

Create credential path

Request

Security
api_key
Bodyapplication/jsonrequired

The credential path to create

credentialPathNamestring<= 255 characters

The name of the credential path.

Example: "ExampleCredentialPath"
descriptionstring<= 1024 characters

The description of the credential path.

Example: "This CredentialPath example has HashiCorp credentialParameters. Example credentialParameter keys for other password vaults: CyberArk (queryString), GCP (versionId, projectId, usernameKey, passwordKey)"
passwordVaultIdinteger(int32)

The ID of the password vault which contains this credential path.

Example: 5
credentialParametersobject

The parameters for this credential path.

Example: {"engine":"my-secrets","path":"hello","usernameKey":"user","passwordKey":"pwd"}
curl -i -X POST \
  https://help-api.delphix.com/_mock/continuous-compliance-engine/2025.3.0.0/cc-engine-apis-2025.3.0.0/credential-paths \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "credentialPathName": "ExampleCredentialPath",
    "description": "This CredentialPath example has HashiCorp credentialParameters. Example credentialParameter keys for other password vaults: CyberArk (queryString), GCP (versionId, projectId, usernameKey, passwordKey)",
    "passwordVaultId": 5,
    "credentialParameters": {
      "engine": "my-secrets",
      "path": "hello",
      "usernameKey": "user",
      "passwordKey": "pwd"
    }
  }'

Responses

Success

Bodyapplication/json
credentialPathIdinteger(int32)read-only

The ID number of the credential path. This field is auto-generated by the Masking Engine.

credentialPathNamestring<= 255 characters

The name of the credential path.

Example: "ExampleCredentialPath"
descriptionstring<= 1024 characters

The description of the credential path.

Example: "This CredentialPath example has HashiCorp credentialParameters. Example credentialParameter keys for other password vaults: CyberArk (queryString), GCP (versionId, projectId, usernameKey, passwordKey)"
passwordVaultIdinteger(int32)

The ID of the password vault which contains this credential path.

Example: 5
credentialParametersobject

The parameters for this credential path.

Example: {"engine":"my-secrets","path":"hello","usernameKey":"user","passwordKey":"pwd"}
Response
application/json
{
  "credentialPathName": "ExampleCredentialPath",
  "description": "This CredentialPath example has HashiCorp credentialParameters. Example credentialParameter keys for other password vaults: CyberArk (queryString), GCP (versionId, projectId, usernameKey, passwordKey)",
  "passwordVaultId": 5,
  "credentialParameters": {
    "engine": "my-secrets",
    "path": "hello",
    "usernameKey": "user",
    "passwordKey": "pwd"
  }
}

Get credential path by ID

Request

Security
api_key
Path
credentialPathIdinteger(int32)required

The ID of the credential path 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/credential-paths/{credentialPathId}' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Success

Bodyapplication/json
credentialPathIdinteger(int32)read-only

The ID number of the credential path. This field is auto-generated by the Masking Engine.

credentialPathNamestring<= 255 characters

The name of the credential path.

Example: "ExampleCredentialPath"
descriptionstring<= 1024 characters

The description of the credential path.

Example: "This CredentialPath example has HashiCorp credentialParameters. Example credentialParameter keys for other password vaults: CyberArk (queryString), GCP (versionId, projectId, usernameKey, passwordKey)"
passwordVaultIdinteger(int32)

The ID of the password vault which contains this credential path.

Example: 5
credentialParametersobject

The parameters for this credential path.

Example: {"engine":"my-secrets","path":"hello","usernameKey":"user","passwordKey":"pwd"}
Response
application/json
{
  "credentialPathName": "ExampleCredentialPath",
  "description": "This CredentialPath example has HashiCorp credentialParameters. Example credentialParameter keys for other password vaults: CyberArk (queryString), GCP (versionId, projectId, usernameKey, passwordKey)",
  "passwordVaultId": 5,
  "credentialParameters": {
    "engine": "my-secrets",
    "path": "hello",
    "usernameKey": "user",
    "passwordKey": "pwd"
  }
}

Update credential path by ID

Request

Security
api_key
Path
credentialPathIdinteger(int32)required

The ID of the credential path to update

Bodyapplication/jsonrequired

The updated credential path

credentialPathNamestring<= 255 characters

The name of the credential path.

Example: "ExampleCredentialPath"
descriptionstring<= 1024 characters

The description of the credential path.

Example: "This CredentialPath example has HashiCorp credentialParameters. Example credentialParameter keys for other password vaults: CyberArk (queryString), GCP (versionId, projectId, usernameKey, passwordKey)"
passwordVaultIdinteger(int32)

The ID of the password vault which contains this credential path.

Example: 5
credentialParametersobject

The parameters for this credential path.

Example: {"engine":"my-secrets","path":"hello","usernameKey":"user","passwordKey":"pwd"}
curl -i -X PUT \
  'https://help-api.delphix.com/_mock/continuous-compliance-engine/2025.3.0.0/cc-engine-apis-2025.3.0.0/credential-paths/{credentialPathId}' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "credentialPathName": "ExampleCredentialPath",
    "description": "This CredentialPath example has HashiCorp credentialParameters. Example credentialParameter keys for other password vaults: CyberArk (queryString), GCP (versionId, projectId, usernameKey, passwordKey)",
    "passwordVaultId": 5,
    "credentialParameters": {
      "engine": "my-secrets",
      "path": "hello",
      "usernameKey": "user",
      "passwordKey": "pwd"
    }
  }'

Responses

Success

Bodyapplication/json
credentialPathIdinteger(int32)read-only

The ID number of the credential path. This field is auto-generated by the Masking Engine.

credentialPathNamestring<= 255 characters

The name of the credential path.

Example: "ExampleCredentialPath"
descriptionstring<= 1024 characters

The description of the credential path.

Example: "This CredentialPath example has HashiCorp credentialParameters. Example credentialParameter keys for other password vaults: CyberArk (queryString), GCP (versionId, projectId, usernameKey, passwordKey)"
passwordVaultIdinteger(int32)

The ID of the password vault which contains this credential path.

Example: 5
credentialParametersobject

The parameters for this credential path.

Example: {"engine":"my-secrets","path":"hello","usernameKey":"user","passwordKey":"pwd"}
Response
application/json
{
  "credentialPathName": "ExampleCredentialPath",
  "description": "This CredentialPath example has HashiCorp credentialParameters. Example credentialParameter keys for other password vaults: CyberArk (queryString), GCP (versionId, projectId, usernameKey, passwordKey)",
  "passwordVaultId": 5,
  "credentialParameters": {
    "engine": "my-secrets",
    "path": "hello",
    "usernameKey": "user",
    "passwordKey": "pwd"
  }
}

Delete credential path by ID

Request

Security
api_key
Path
credentialPathIdinteger(int32)required

The ID of the credential path 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/credential-paths/{credentialPathId}' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Success

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