Skip to content
/
Create password vault

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

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

Get all password vaults

Request

Security
api_key
Query
page_numberinteger(int64)

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

Responses

Success

Bodyapplication/json
_pageInfoobject(PageInfo)
responseListArray of objects(PasswordVault)
Example: [{"name":"SampleVault","vaultType":"HASHICORP","configJson":{"host":"12.345.678.90","port":8200,"namespace":"sample/child","authType":"TOKEN","token":"hvs.kvIT"},"description":"This password vault is used as an API example."}]
Response
application/json
{
  "_pageInfo": {
    "numberOnPage": 0,
    "total": 0
  },
  "responseList": [
    { … }
  ]
}

Create password vault

Request

Security
api_key
Bodyapplication/jsonrequired

The password vault to create

namestring<= 255 characters

The name of the password vault. This must be unique across all password vaults on the engine.

Example: "SampleVault"
vaultTypestring

The type of password vault. Currently, HASHICORP, CYBERARK and GCP are supported.

Default "HASHICORP"
Enum"CYBERARK""HASHICORP""GCP""AZURE"
Example: "HASHICORP"
configJsonobject

The configuration properties used to connect to the password vault.

Example: {"host":"12.345.678.90","port":8200,"namespace":"sample/child","authType":"TOKEN","token":"hvs.kvIT"}
descriptionstring<= 1024 characters

The description of the password vault.

Example: "This password vault is used as an API example."
curl -i -X POST \
  https://help-api.delphix.com/_mock/continuous-compliance-engine/2025.3.0.0/cc-engine-apis-2025.3.0.0/password-vaults \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "SampleVault",
    "vaultType": "HASHICORP",
    "configJson": {
      "host": "12.345.678.90",
      "port": 8200,
      "namespace": "sample/child",
      "authType": "TOKEN",
      "token": "hvs.kvIT"
    },
    "description": "This password vault is used as an API example."
  }'

Responses

Success

Bodyapplication/json
passwordVaultIdinteger(int32)read-only

The ID of the password vault. This field is set by the Masking Engine.

namestring<= 255 characters

The name of the password vault. This must be unique across all password vaults on the engine.

Example: "SampleVault"
vaultTypestring

The type of password vault. Currently, HASHICORP, CYBERARK and GCP are supported.

Default "HASHICORP"
Enum"CYBERARK""HASHICORP""GCP""AZURE"
Example: "HASHICORP"
configJsonobject

The configuration properties used to connect to the password vault.

Example: {"host":"12.345.678.90","port":8200,"namespace":"sample/child","authType":"TOKEN","token":"hvs.kvIT"}
descriptionstring<= 1024 characters

The description of the password vault.

Example: "This password vault is used as an API example."
Response
application/json
{
  "name": "SampleVault",
  "vaultType": "HASHICORP",
  "configJson": {
    "host": "12.345.678.90",
    "port": 8200,
    "namespace": "sample/child",
    "authType": "TOKEN",
    "token": "hvs.kvIT"
  },
  "description": "This password vault is used as an API example."
}

Get password vault by ID

Request

Security
api_key
Path
passwordVaultIdinteger(int32)required

The ID of the password vault 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/password-vaults/{passwordVaultId}' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Success

Bodyapplication/json
passwordVaultIdinteger(int32)read-only

The ID of the password vault. This field is set by the Masking Engine.

namestring<= 255 characters

The name of the password vault. This must be unique across all password vaults on the engine.

Example: "SampleVault"
vaultTypestring

The type of password vault. Currently, HASHICORP, CYBERARK and GCP are supported.

Default "HASHICORP"
Enum"CYBERARK""HASHICORP""GCP""AZURE"
Example: "HASHICORP"
configJsonobject

The configuration properties used to connect to the password vault.

Example: {"host":"12.345.678.90","port":8200,"namespace":"sample/child","authType":"TOKEN","token":"hvs.kvIT"}
descriptionstring<= 1024 characters

The description of the password vault.

Example: "This password vault is used as an API example."
Response
application/json
{
  "name": "SampleVault",
  "vaultType": "HASHICORP",
  "configJson": {
    "host": "12.345.678.90",
    "port": 8200,
    "namespace": "sample/child",
    "authType": "TOKEN",
    "token": "hvs.kvIT"
  },
  "description": "This password vault is used as an API example."
}

Update password vault by ID

Request

Security
api_key
Path
passwordVaultIdinteger(int32)required

The ID of the password vault to update

Bodyapplication/jsonrequired

The updated password vault

namestring<= 255 characters

The name of the password vault. This must be unique across all password vaults on the engine.

Example: "SampleVault"
vaultTypestring

The type of password vault. Currently, HASHICORP, CYBERARK and GCP are supported.

Default "HASHICORP"
Enum"CYBERARK""HASHICORP""GCP""AZURE"
Example: "HASHICORP"
configJsonobject

The configuration properties used to connect to the password vault.

Example: {"host":"12.345.678.90","port":8200,"namespace":"sample/child","authType":"TOKEN","token":"hvs.kvIT"}
descriptionstring<= 1024 characters

The description of the password vault.

Example: "This password vault is used as an API example."
curl -i -X PUT \
  'https://help-api.delphix.com/_mock/continuous-compliance-engine/2025.3.0.0/cc-engine-apis-2025.3.0.0/password-vaults/{passwordVaultId}' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "SampleVault",
    "vaultType": "HASHICORP",
    "configJson": {
      "host": "12.345.678.90",
      "port": 8200,
      "namespace": "sample/child",
      "authType": "TOKEN",
      "token": "hvs.kvIT"
    },
    "description": "This password vault is used as an API example."
  }'

Responses

Success

Bodyapplication/json
passwordVaultIdinteger(int32)read-only

The ID of the password vault. This field is set by the Masking Engine.

namestring<= 255 characters

The name of the password vault. This must be unique across all password vaults on the engine.

Example: "SampleVault"
vaultTypestring

The type of password vault. Currently, HASHICORP, CYBERARK and GCP are supported.

Default "HASHICORP"
Enum"CYBERARK""HASHICORP""GCP""AZURE"
Example: "HASHICORP"
configJsonobject

The configuration properties used to connect to the password vault.

Example: {"host":"12.345.678.90","port":8200,"namespace":"sample/child","authType":"TOKEN","token":"hvs.kvIT"}
descriptionstring<= 1024 characters

The description of the password vault.

Example: "This password vault is used as an API example."
Response
application/json
{
  "name": "SampleVault",
  "vaultType": "HASHICORP",
  "configJson": {
    "host": "12.345.678.90",
    "port": 8200,
    "namespace": "sample/child",
    "authType": "TOKEN",
    "token": "hvs.kvIT"
  },
  "description": "This password vault is used as an API example."
}

Delete password vault by ID

Request

Security
api_key
Path
passwordVaultIdinteger(int32)required

The ID of the password vault 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/password-vaults/{passwordVaultId}' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Success

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