Fetch all accessible file names

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

Get all Mainframe Dataset connectors

Request

Security

api_key

Query

environment_idinteger(int32)

The ID of the environment to get all Mainframe Dataset connectors from

page_numberinteger(int64)

The page number for which to get Mainframe Dataset connectors. 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/2026.1.0.0/cc-engine-apis-2026.1.0.0/mainframe-dataset-connectors?environment_id=0&page_number=1&page_size=0' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Successful operation

Bodyapplication/json

_pageInfoobject(PageInfo)

responseListArray of objects(MainframeDatasetConnector)

Example: [{"connectorName":"mainframe_dataset_connector_via_sftp","environmentId":123,"connectionInfo":{"connectionMode":"SFTP","path":"/path/to/files","host":"host123.server.com","loginName":"ftpuser","port":23456,"sshKey":"ssh_host_rsa_key","userDirIsRoot":false}}]

Response

application/json

{
  "_pageInfo": {
    "numberOnPage": 0,
    "total": 0
  },
  "responseList": [
    { … }
  ]
}

Create Mainframe Dataset connector

Request

Security

api_key

Bodyapplication/jsonrequired

The Mainframe Dataset connector to create

connectorNamestring<= 45 charactersrequired

The name of the Mainframe Dataset connector.

Example: "mainframe_dataset_connector_via_sftp"

environmentIdinteger(int32)required

The ID number of the environment that the Mainframe Dataset connector is in. Once the Mainframe Dataset connector is created, this field cannot be changed.

Example: 123

connectionInfoobject(ConnectionInfo)required

connectionInfo.connectionModestringrequired

This field denotes which connection mode the connector will use to connect to the underlying files.

Enum"FTP""MOUNT""SFTP""FTPS""AWS_S3""S3_COMPATIBLE""AZURE_BLOB_STORAGE"

connectionInfo.isMvsStorageboolean

This field denotes the type of storage is MVS or not. It's readonly(not persisted) and also only applicable for mainframe connectors.

connectionInfo.pathstring<= 255 characters

This field applies to all connection modes, and it is the file system path to the desired files.

connectionInfo.mountIdinteger(int32)

This field only applies to the Filesystem Mount Point connection mode, and it is the id of the mount containing the desired files.

connectionInfo.hoststring<= 255 characters

This field is the host address belonging to the FTP/SFTP server.

connectionInfo.loginNamestring<= 255 characters

This field is the login name to be used to authenticate with the FTP/SFTP server.

connectionInfo.passwordstring<= 255 characters

This field is the password to be used to authenticate with the FTP/SFTP server. Note that for SFTP authentication, only one of the 'password' or 'sshKey' fields should be provided.

connectionInfo.portinteger(int32)

This field is the port number on the host address that the FTP/SFTP server is listening to.

connectionInfo.sshKeystring<= 255 characters

This field only applies to the SFTP connection mode, and it is a reference to the public SSH key to be used as an alternative means of authentication to the SFTP server. The public SSH key must already exist on the Masking Engine under the directory '/var/delphix/dmsuite/resources/SSHKeys'. Note that only one of the 'password' or 'sshKey' fields should be provided.

connectionInfo.userDirIsRootboolean

This field only applies to the SFTP connection mode. A value of true indicates that path is relative to the SFTP server defined user directory, while false means it is an absolute path. Setting this value incorrectly may cause the SFTP connection to fail.

Default false

connectionInfo.awsBucketNamestring<= 255 characters

This field is the bucket name for aws s3.

connectionInfo.awsRegionstring<= 100 characters

This field is the region of aws s3 bucket.

connectionInfo.awsAccessKeystring<= 255 characters

This field is the access key to access the s3 object.

connectionInfo.awsSecretKeystring<= 255 characters

This field is the secret key to access the s3 object.

connectionInfo.awsAuthTypestring<= 50 characters

This field is the type of s3 authentication.

connectionInfo.prefixstring<= 1024 characters

This field is the prefix for filteration.

connectionInfo.delimiterstring<= 1024 characters

This field is the delimiter for filteration.

connectionInfo.s3CompatibleDetailsobject(S3CompatibleDetails)

connectionInfo.azureBlobStorageDetailsobject(AzureBlobStorageDetails)

connectionInfo.credentialPathIdinteger(int32)

The ID of the credential path to use for this connector. Used to retrieve credentials from a password vault.

curl -i -X POST \
  https://help-api.delphix.com/_mock/continuous-compliance-engine/2026.1.0.0/cc-engine-apis-2026.1.0.0/mainframe-dataset-connectors \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "connectorName": "mainframe_dataset_connector_via_sftp",
    "environmentId": 123,
    "connectionInfo": {
      "connectionMode": "SFTP",
      "path": "/path/to/files",
      "host": "host123.server.com",
      "loginName": "ftpuser",
      "port": 23456,
      "sshKey": "ssh_host_rsa_key",
      "userDirIsRoot": false
    }
  }'

Responses

Successful operation

Bodyapplication/json

mainframeDatasetConnectorIdinteger(int32)read-only

The ID number of the Mainframe Dataset connector. This field is auto-generated by the Masking Engine.

connectorNamestring<= 45 charactersrequired

The name of the Mainframe Dataset connector.

Example: "mainframe_dataset_connector_via_sftp"

environmentIdinteger(int32)required

The ID number of the environment that the Mainframe Dataset connector is in. Once the Mainframe Dataset connector is created, this field cannot be changed.

Example: 123

connectionInfoobject(ConnectionInfo)required

connectionInfo.connectionModestringrequired

This field denotes which connection mode the connector will use to connect to the underlying files.

Enum"FTP""MOUNT""SFTP""FTPS""AWS_S3""S3_COMPATIBLE""AZURE_BLOB_STORAGE"

connectionInfo.isMvsStorageboolean

This field denotes the type of storage is MVS or not. It's readonly(not persisted) and also only applicable for mainframe connectors.

connectionInfo.pathstring<= 255 characters

This field applies to all connection modes, and it is the file system path to the desired files.

connectionInfo.mountIdinteger(int32)

This field only applies to the Filesystem Mount Point connection mode, and it is the id of the mount containing the desired files.

connectionInfo.hoststring<= 255 characters

This field is the host address belonging to the FTP/SFTP server.

connectionInfo.loginNamestring<= 255 characters

This field is the login name to be used to authenticate with the FTP/SFTP server.

connectionInfo.passwordstring<= 255 characters

This field is the password to be used to authenticate with the FTP/SFTP server. Note that for SFTP authentication, only one of the 'password' or 'sshKey' fields should be provided.

connectionInfo.portinteger(int32)

This field is the port number on the host address that the FTP/SFTP server is listening to.

connectionInfo.sshKeystring<= 255 characters

This field only applies to the SFTP connection mode, and it is a reference to the public SSH key to be used as an alternative means of authentication to the SFTP server. The public SSH key must already exist on the Masking Engine under the directory '/var/delphix/dmsuite/resources/SSHKeys'. Note that only one of the 'password' or 'sshKey' fields should be provided.

connectionInfo.userDirIsRootboolean

This field only applies to the SFTP connection mode. A value of true indicates that path is relative to the SFTP server defined user directory, while false means it is an absolute path. Setting this value incorrectly may cause the SFTP connection to fail.

Default false

connectionInfo.awsBucketNamestring<= 255 characters

This field is the bucket name for aws s3.

connectionInfo.awsRegionstring<= 100 characters

This field is the region of aws s3 bucket.

connectionInfo.awsAccessKeystring<= 255 characters

This field is the access key to access the s3 object.

connectionInfo.awsSecretKeystring<= 255 characters

This field is the secret key to access the s3 object.

connectionInfo.awsAuthTypestring<= 50 characters

This field is the type of s3 authentication.

connectionInfo.prefixstring<= 1024 characters

This field is the prefix for filteration.

connectionInfo.delimiterstring<= 1024 characters

This field is the delimiter for filteration.

connectionInfo.s3CompatibleDetailsobject(S3CompatibleDetails)

connectionInfo.azureBlobStorageDetailsobject(AzureBlobStorageDetails)

connectionInfo.passwordVaultAuthbooleanread-only

Whether the connector uses password vault for authentication or not. This is a read-only field, determined by if credentialPathId is provided.

connectionInfo.credentialPathIdinteger(int32)

The ID of the credential path to use for this connector. Used to retrieve credentials from a password vault.

authPresentstringread-only

Denotes whether authentication is present or not for this connector, UI only field

Response

application/json

{
  "connectorName": "mainframe_dataset_connector_via_sftp",
  "environmentId": 123,
  "connectionInfo": {
    "connectionMode": "SFTP",
    "path": "/path/to/files",
    "host": "host123.server.com",
    "loginName": "ftpuser",
    "port": 23456,
    "sshKey": "ssh_host_rsa_key",
    "userDirIsRoot": false
  }
}

Get Mainframe Dataset connector by ID

Request

Security

api_key

Path

mainframeDatasetConnectorIdinteger(int32)required

The ID of the Mainframe Dataset connector to get

curl -i -X GET \
  'https://help-api.delphix.com/_mock/continuous-compliance-engine/2026.1.0.0/cc-engine-apis-2026.1.0.0/mainframe-dataset-connectors/{mainframeDatasetConnectorId}' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Successful operation

Bodyapplication/json

mainframeDatasetConnectorIdinteger(int32)read-only

The ID number of the Mainframe Dataset connector. This field is auto-generated by the Masking Engine.

connectorNamestring<= 45 charactersrequired

The name of the Mainframe Dataset connector.

Example: "mainframe_dataset_connector_via_sftp"

environmentIdinteger(int32)required

The ID number of the environment that the Mainframe Dataset connector is in. Once the Mainframe Dataset connector is created, this field cannot be changed.

Example: 123

connectionInfoobject(ConnectionInfo)required

connectionInfo.connectionModestringrequired

This field denotes which connection mode the connector will use to connect to the underlying files.

Enum"FTP""MOUNT""SFTP""FTPS""AWS_S3""S3_COMPATIBLE""AZURE_BLOB_STORAGE"

connectionInfo.isMvsStorageboolean

This field denotes the type of storage is MVS or not. It's readonly(not persisted) and also only applicable for mainframe connectors.

connectionInfo.pathstring<= 255 characters

This field applies to all connection modes, and it is the file system path to the desired files.

connectionInfo.mountIdinteger(int32)

This field only applies to the Filesystem Mount Point connection mode, and it is the id of the mount containing the desired files.

connectionInfo.hoststring<= 255 characters

This field is the host address belonging to the FTP/SFTP server.

connectionInfo.loginNamestring<= 255 characters

This field is the login name to be used to authenticate with the FTP/SFTP server.

connectionInfo.passwordstring<= 255 characters

This field is the password to be used to authenticate with the FTP/SFTP server. Note that for SFTP authentication, only one of the 'password' or 'sshKey' fields should be provided.

connectionInfo.portinteger(int32)

This field is the port number on the host address that the FTP/SFTP server is listening to.

connectionInfo.sshKeystring<= 255 characters

This field only applies to the SFTP connection mode, and it is a reference to the public SSH key to be used as an alternative means of authentication to the SFTP server. The public SSH key must already exist on the Masking Engine under the directory '/var/delphix/dmsuite/resources/SSHKeys'. Note that only one of the 'password' or 'sshKey' fields should be provided.

connectionInfo.userDirIsRootboolean

This field only applies to the SFTP connection mode. A value of true indicates that path is relative to the SFTP server defined user directory, while false means it is an absolute path. Setting this value incorrectly may cause the SFTP connection to fail.

Default false

connectionInfo.awsBucketNamestring<= 255 characters

This field is the bucket name for aws s3.

connectionInfo.awsRegionstring<= 100 characters

This field is the region of aws s3 bucket.

connectionInfo.awsAccessKeystring<= 255 characters

This field is the access key to access the s3 object.

connectionInfo.awsSecretKeystring<= 255 characters

This field is the secret key to access the s3 object.

connectionInfo.awsAuthTypestring<= 50 characters

This field is the type of s3 authentication.

connectionInfo.prefixstring<= 1024 characters

This field is the prefix for filteration.

connectionInfo.delimiterstring<= 1024 characters

This field is the delimiter for filteration.

connectionInfo.s3CompatibleDetailsobject(S3CompatibleDetails)

connectionInfo.azureBlobStorageDetailsobject(AzureBlobStorageDetails)

connectionInfo.passwordVaultAuthbooleanread-only

Whether the connector uses password vault for authentication or not. This is a read-only field, determined by if credentialPathId is provided.

connectionInfo.credentialPathIdinteger(int32)

The ID of the credential path to use for this connector. Used to retrieve credentials from a password vault.

authPresentstringread-only

Denotes whether authentication is present or not for this connector, UI only field

Response

application/json

{
  "connectorName": "mainframe_dataset_connector_via_sftp",
  "environmentId": 123,
  "connectionInfo": {
    "connectionMode": "SFTP",
    "path": "/path/to/files",
    "host": "host123.server.com",
    "loginName": "ftpuser",
    "port": 23456,
    "sshKey": "ssh_host_rsa_key",
    "userDirIsRoot": false
  }
}

Update Mainframe Dataset connector by ID

Request

Security

api_key

Path

mainframeDatasetConnectorIdinteger(int32)required

The ID of the Mainframe Dataset connector to update

Bodyapplication/jsonrequired

The updated Mainframe Dataset connector

connectorNamestring<= 45 charactersrequired

The name of the Mainframe Dataset connector.

Example: "mainframe_dataset_connector_via_sftp"

environmentIdinteger(int32)required

The ID number of the environment that the Mainframe Dataset connector is in. Once the Mainframe Dataset connector is created, this field cannot be changed.

Example: 123

connectionInfoobject(ConnectionInfo)required

connectionInfo.connectionModestringrequired

This field denotes which connection mode the connector will use to connect to the underlying files.

Enum"FTP""MOUNT""SFTP""FTPS""AWS_S3""S3_COMPATIBLE""AZURE_BLOB_STORAGE"

connectionInfo.isMvsStorageboolean

This field denotes the type of storage is MVS or not. It's readonly(not persisted) and also only applicable for mainframe connectors.

connectionInfo.pathstring<= 255 characters

This field applies to all connection modes, and it is the file system path to the desired files.

connectionInfo.mountIdinteger(int32)

This field only applies to the Filesystem Mount Point connection mode, and it is the id of the mount containing the desired files.

connectionInfo.hoststring<= 255 characters

This field is the host address belonging to the FTP/SFTP server.

connectionInfo.loginNamestring<= 255 characters

This field is the login name to be used to authenticate with the FTP/SFTP server.

connectionInfo.passwordstring<= 255 characters

This field is the password to be used to authenticate with the FTP/SFTP server. Note that for SFTP authentication, only one of the 'password' or 'sshKey' fields should be provided.

connectionInfo.portinteger(int32)

This field is the port number on the host address that the FTP/SFTP server is listening to.

connectionInfo.sshKeystring<= 255 characters

This field only applies to the SFTP connection mode, and it is a reference to the public SSH key to be used as an alternative means of authentication to the SFTP server. The public SSH key must already exist on the Masking Engine under the directory '/var/delphix/dmsuite/resources/SSHKeys'. Note that only one of the 'password' or 'sshKey' fields should be provided.

connectionInfo.userDirIsRootboolean

This field only applies to the SFTP connection mode. A value of true indicates that path is relative to the SFTP server defined user directory, while false means it is an absolute path. Setting this value incorrectly may cause the SFTP connection to fail.

Default false

connectionInfo.awsBucketNamestring<= 255 characters

This field is the bucket name for aws s3.

connectionInfo.awsRegionstring<= 100 characters

This field is the region of aws s3 bucket.

connectionInfo.awsAccessKeystring<= 255 characters

This field is the access key to access the s3 object.

connectionInfo.awsSecretKeystring<= 255 characters

This field is the secret key to access the s3 object.

connectionInfo.awsAuthTypestring<= 50 characters

This field is the type of s3 authentication.

connectionInfo.prefixstring<= 1024 characters

This field is the prefix for filteration.

connectionInfo.delimiterstring<= 1024 characters

This field is the delimiter for filteration.

connectionInfo.s3CompatibleDetailsobject(S3CompatibleDetails)

connectionInfo.azureBlobStorageDetailsobject(AzureBlobStorageDetails)

connectionInfo.credentialPathIdinteger(int32)

The ID of the credential path to use for this connector. Used to retrieve credentials from a password vault.

curl -i -X PUT \
  'https://help-api.delphix.com/_mock/continuous-compliance-engine/2026.1.0.0/cc-engine-apis-2026.1.0.0/mainframe-dataset-connectors/{mainframeDatasetConnectorId}' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "connectorName": "mainframe_dataset_connector_via_sftp",
    "environmentId": 123,
    "connectionInfo": {
      "connectionMode": "SFTP",
      "path": "/path/to/files",
      "host": "host123.server.com",
      "loginName": "ftpuser",
      "port": 23456,
      "sshKey": "ssh_host_rsa_key",
      "userDirIsRoot": false
    }
  }'

Responses

Successful operation

Bodyapplication/json

mainframeDatasetConnectorIdinteger(int32)read-only

The ID number of the Mainframe Dataset connector. This field is auto-generated by the Masking Engine.

connectorNamestring<= 45 charactersrequired

The name of the Mainframe Dataset connector.

Example: "mainframe_dataset_connector_via_sftp"

environmentIdinteger(int32)required

The ID number of the environment that the Mainframe Dataset connector is in. Once the Mainframe Dataset connector is created, this field cannot be changed.

Example: 123

connectionInfoobject(ConnectionInfo)required

connectionInfo.connectionModestringrequired

This field denotes which connection mode the connector will use to connect to the underlying files.

Enum"FTP""MOUNT""SFTP""FTPS""AWS_S3""S3_COMPATIBLE""AZURE_BLOB_STORAGE"

connectionInfo.isMvsStorageboolean

This field denotes the type of storage is MVS or not. It's readonly(not persisted) and also only applicable for mainframe connectors.

connectionInfo.pathstring<= 255 characters

This field applies to all connection modes, and it is the file system path to the desired files.

connectionInfo.mountIdinteger(int32)

This field only applies to the Filesystem Mount Point connection mode, and it is the id of the mount containing the desired files.

connectionInfo.hoststring<= 255 characters

This field is the host address belonging to the FTP/SFTP server.

connectionInfo.loginNamestring<= 255 characters

This field is the login name to be used to authenticate with the FTP/SFTP server.

connectionInfo.passwordstring<= 255 characters

This field is the password to be used to authenticate with the FTP/SFTP server. Note that for SFTP authentication, only one of the 'password' or 'sshKey' fields should be provided.

connectionInfo.portinteger(int32)

This field is the port number on the host address that the FTP/SFTP server is listening to.

connectionInfo.sshKeystring<= 255 characters

This field only applies to the SFTP connection mode, and it is a reference to the public SSH key to be used as an alternative means of authentication to the SFTP server. The public SSH key must already exist on the Masking Engine under the directory '/var/delphix/dmsuite/resources/SSHKeys'. Note that only one of the 'password' or 'sshKey' fields should be provided.

connectionInfo.userDirIsRootboolean

This field only applies to the SFTP connection mode. A value of true indicates that path is relative to the SFTP server defined user directory, while false means it is an absolute path. Setting this value incorrectly may cause the SFTP connection to fail.

Default false

connectionInfo.awsBucketNamestring<= 255 characters

This field is the bucket name for aws s3.

connectionInfo.awsRegionstring<= 100 characters

This field is the region of aws s3 bucket.

connectionInfo.awsAccessKeystring<= 255 characters

This field is the access key to access the s3 object.

connectionInfo.awsSecretKeystring<= 255 characters

This field is the secret key to access the s3 object.

connectionInfo.awsAuthTypestring<= 50 characters

This field is the type of s3 authentication.

connectionInfo.prefixstring<= 1024 characters

This field is the prefix for filteration.

connectionInfo.delimiterstring<= 1024 characters

This field is the delimiter for filteration.

connectionInfo.s3CompatibleDetailsobject(S3CompatibleDetails)

connectionInfo.azureBlobStorageDetailsobject(AzureBlobStorageDetails)

connectionInfo.passwordVaultAuthbooleanread-only

Whether the connector uses password vault for authentication or not. This is a read-only field, determined by if credentialPathId is provided.

connectionInfo.credentialPathIdinteger(int32)

The ID of the credential path to use for this connector. Used to retrieve credentials from a password vault.

authPresentstringread-only

Denotes whether authentication is present or not for this connector, UI only field

Response

application/json

{
  "connectorName": "mainframe_dataset_connector_via_sftp",
  "environmentId": 123,
  "connectionInfo": {
    "connectionMode": "SFTP",
    "path": "/path/to/files",
    "host": "host123.server.com",
    "loginName": "ftpuser",
    "port": 23456,
    "sshKey": "ssh_host_rsa_key",
    "userDirIsRoot": false
  }
}

Delete Mainframe Dataset connector by ID

Request

Security

api_key

Path

mainframeDatasetConnectorIdinteger(int32)required

The ID of the Mainframe Dataset connector to delete

curl -i -X DELETE \
  'https://help-api.delphix.com/_mock/continuous-compliance-engine/2026.1.0.0/cc-engine-apis-2026.1.0.0/mainframe-dataset-connectors/{mainframeDatasetConnectorId}' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Successful operation

Fetch all accessible file names

Request

Note that even the names of files in the directory path that are not readable or writable will be returned

Security

api_key

Path

mainframeDatasetConnectorIdinteger(int32)required

The ID of the Mainframe Dataset connector to fetch the files for

Query

hideExistingboolean

This flag specifies fetching only table names that are not already part of a particular ruleset.

rulesetIdinteger(int32)

Ruleset ID to check if the file is already added. Required in case of hideExisting is set to true.

curl -i -X GET \
  'https://help-api.delphix.com/_mock/continuous-compliance-engine/2026.1.0.0/cc-engine-apis-2026.1.0.0/mainframe-dataset-connectors/{mainframeDatasetConnectorId}/fetch?hideExisting=true&rulesetId=0' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Successful operation

Bodyapplication/jsonArray [

string

]

Response

application/json

[
  "string"
]

Test Mainframe Dataset connector by ID

Request

WARNING: There is a known bug in the API Client where it is impossible to submit a request with an 'empty' body. As such, only the 'full' body variant of this endpoint can be used through the API Client. To use the 'empty' body variant of this endpoint, please do not use the API Client, but instead use curl or some other method of issuing HTTP requests.

Security

api_key

Path

mainframeDatasetConnectorIdinteger(int32)required

The ID of the Mainframe Dataset connector to test

Bodyapplication/json

The Mainframe Dataset connector to test. This field is optional and if no password or sshkey is supplied with the connector then the password associated with the fileConnectorId will be used.

connectorNamestring<= 45 charactersrequired

The name of the Mainframe Dataset connector.

Example: "mainframe_dataset_connector_via_sftp"

environmentIdinteger(int32)required

The ID number of the environment that the Mainframe Dataset connector is in. Once the Mainframe Dataset connector is created, this field cannot be changed.

Example: 123

connectionInfoobject(ConnectionInfo)required

connectionInfo.connectionModestringrequired

This field denotes which connection mode the connector will use to connect to the underlying files.

Enum"FTP""MOUNT""SFTP""FTPS""AWS_S3""S3_COMPATIBLE""AZURE_BLOB_STORAGE"

connectionInfo.isMvsStorageboolean

This field denotes the type of storage is MVS or not. It's readonly(not persisted) and also only applicable for mainframe connectors.

connectionInfo.pathstring<= 255 characters

This field applies to all connection modes, and it is the file system path to the desired files.

connectionInfo.mountIdinteger(int32)

This field only applies to the Filesystem Mount Point connection mode, and it is the id of the mount containing the desired files.

connectionInfo.hoststring<= 255 characters

This field is the host address belonging to the FTP/SFTP server.

connectionInfo.loginNamestring<= 255 characters

This field is the login name to be used to authenticate with the FTP/SFTP server.

connectionInfo.passwordstring<= 255 characters

This field is the password to be used to authenticate with the FTP/SFTP server. Note that for SFTP authentication, only one of the 'password' or 'sshKey' fields should be provided.

connectionInfo.portinteger(int32)

This field is the port number on the host address that the FTP/SFTP server is listening to.

connectionInfo.sshKeystring<= 255 characters

This field only applies to the SFTP connection mode, and it is a reference to the public SSH key to be used as an alternative means of authentication to the SFTP server. The public SSH key must already exist on the Masking Engine under the directory '/var/delphix/dmsuite/resources/SSHKeys'. Note that only one of the 'password' or 'sshKey' fields should be provided.

connectionInfo.userDirIsRootboolean

This field only applies to the SFTP connection mode. A value of true indicates that path is relative to the SFTP server defined user directory, while false means it is an absolute path. Setting this value incorrectly may cause the SFTP connection to fail.

Default false

connectionInfo.awsBucketNamestring<= 255 characters

This field is the bucket name for aws s3.

connectionInfo.awsRegionstring<= 100 characters

This field is the region of aws s3 bucket.

connectionInfo.awsAccessKeystring<= 255 characters

This field is the access key to access the s3 object.

connectionInfo.awsSecretKeystring<= 255 characters

This field is the secret key to access the s3 object.

connectionInfo.awsAuthTypestring<= 50 characters

This field is the type of s3 authentication.

connectionInfo.prefixstring<= 1024 characters

This field is the prefix for filteration.

connectionInfo.delimiterstring<= 1024 characters

This field is the delimiter for filteration.

connectionInfo.s3CompatibleDetailsobject(S3CompatibleDetails)

connectionInfo.azureBlobStorageDetailsobject(AzureBlobStorageDetails)

connectionInfo.credentialPathIdinteger(int32)

The ID of the credential path to use for this connector. Used to retrieve credentials from a password vault.

curl -i -X POST \
  'https://help-api.delphix.com/_mock/continuous-compliance-engine/2026.1.0.0/cc-engine-apis-2026.1.0.0/mainframe-dataset-connectors/{mainframeDatasetConnectorId}/test' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "connectorName": "mainframe_dataset_connector_via_sftp",
    "environmentId": 123,
    "connectionInfo": {
      "connectionMode": "SFTP",
      "path": "/path/to/files",
      "host": "host123.server.com",
      "loginName": "ftpuser",
      "port": 23456,
      "sshKey": "ssh_host_rsa_key",
      "userDirIsRoot": false
    }
  }'

Responses

Successful operation

Bodyapplication/json

responsestring

Success or failure of the connection test.

Response

application/json

{
  "response": "string"
}

Test an unsaved Mainframe Dataset connector

Request

Security

api_key

Bodyapplication/jsonrequired

The Mainframe Dataset connector to test

connectorNamestring<= 45 charactersrequired

The name of the Mainframe Dataset connector.

Example: "mainframe_dataset_connector_via_sftp"

environmentIdinteger(int32)required

The ID number of the environment that the Mainframe Dataset connector is in. Once the Mainframe Dataset connector is created, this field cannot be changed.

Example: 123

connectionInfoobject(ConnectionInfo)required

connectionInfo.connectionModestringrequired

This field denotes which connection mode the connector will use to connect to the underlying files.

Enum"FTP""MOUNT""SFTP""FTPS""AWS_S3""S3_COMPATIBLE""AZURE_BLOB_STORAGE"

connectionInfo.isMvsStorageboolean

This field denotes the type of storage is MVS or not. It's readonly(not persisted) and also only applicable for mainframe connectors.

connectionInfo.pathstring<= 255 characters

This field applies to all connection modes, and it is the file system path to the desired files.

connectionInfo.mountIdinteger(int32)

This field only applies to the Filesystem Mount Point connection mode, and it is the id of the mount containing the desired files.

connectionInfo.hoststring<= 255 characters

This field is the host address belonging to the FTP/SFTP server.

connectionInfo.loginNamestring<= 255 characters

This field is the login name to be used to authenticate with the FTP/SFTP server.

connectionInfo.passwordstring<= 255 characters

This field is the password to be used to authenticate with the FTP/SFTP server. Note that for SFTP authentication, only one of the 'password' or 'sshKey' fields should be provided.

connectionInfo.portinteger(int32)

This field is the port number on the host address that the FTP/SFTP server is listening to.

connectionInfo.sshKeystring<= 255 characters

This field only applies to the SFTP connection mode, and it is a reference to the public SSH key to be used as an alternative means of authentication to the SFTP server. The public SSH key must already exist on the Masking Engine under the directory '/var/delphix/dmsuite/resources/SSHKeys'. Note that only one of the 'password' or 'sshKey' fields should be provided.

connectionInfo.userDirIsRootboolean

This field only applies to the SFTP connection mode. A value of true indicates that path is relative to the SFTP server defined user directory, while false means it is an absolute path. Setting this value incorrectly may cause the SFTP connection to fail.

Default false

connectionInfo.awsBucketNamestring<= 255 characters

This field is the bucket name for aws s3.

connectionInfo.awsRegionstring<= 100 characters

This field is the region of aws s3 bucket.

connectionInfo.awsAccessKeystring<= 255 characters

This field is the access key to access the s3 object.

connectionInfo.awsSecretKeystring<= 255 characters

This field is the secret key to access the s3 object.

connectionInfo.awsAuthTypestring<= 50 characters

This field is the type of s3 authentication.

connectionInfo.prefixstring<= 1024 characters

This field is the prefix for filteration.

connectionInfo.delimiterstring<= 1024 characters

This field is the delimiter for filteration.

connectionInfo.s3CompatibleDetailsobject(S3CompatibleDetails)

connectionInfo.azureBlobStorageDetailsobject(AzureBlobStorageDetails)

connectionInfo.credentialPathIdinteger(int32)

The ID of the credential path to use for this connector. Used to retrieve credentials from a password vault.

curl -i -X POST \
  https://help-api.delphix.com/_mock/continuous-compliance-engine/2026.1.0.0/cc-engine-apis-2026.1.0.0/mainframe-dataset-connectors/test \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "connectorName": "mainframe_dataset_connector_via_sftp",
    "environmentId": 123,
    "connectionInfo": {
      "connectionMode": "SFTP",
      "path": "/path/to/files",
      "host": "host123.server.com",
      "loginName": "ftpuser",
      "port": 23456,
      "sshKey": "ssh_host_rsa_key",
      "userDirIsRoot": false
    }
  }'

Responses

Success

Bodyapplication/json

responsestring

Success or failure of the connection test.

Response

application/json

{
  "response": "string"
}

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

Masking API (5.1.47)CopyCopy for LLMCopy page as Markdown for LLMsView as MarkdownOpen this page as MarkdownOpen in ChatGPTGet insights from ChatGPTOpen in ClaudeGet insights from ClaudeConnect to CursorInstall MCP server on CursorConnect to VS CodeInstall MCP server on VS Code

algorithm

logging

application

applicationSettings

asyncTask

billingUsage

classifier

columnMetadata

credentialPath

configuration

databaseConnector

databaseRuleset

domain

encryptionKey

environment

execution

executionComponent

executionEvent

sync

fileConnector

fileDownload

fileFieldMetadata

fileFormat

fileMetadata

fileRuleset

fileUpload

inventoryApproval

knowledgeBaseInfo

jdbcDriver

license

login

mainframeDatasetConnector

Get all Mainframe Dataset connectors

Request

Responses

Was this helpful?

Create Mainframe Dataset connector

RequestExpand all

Responses

Was this helpful?

Get Mainframe Dataset connector by ID

Request

Responses

Was this helpful?

Update Mainframe Dataset connector by ID

RequestExpand all

Responses

Was this helpful?

Delete Mainframe Dataset connector by ID

Request

Responses

Was this helpful?

Fetch all accessible file names

Request

Responses

Was this helpful?

Test Mainframe Dataset connector by ID

RequestExpand all

Responses

Was this helpful?

Test an unsaved Mainframe Dataset connector

RequestExpand all

Responses

Was this helpful?

mainframeDatasetFieldMetadata

mainframeDatasetFormat

mainframeDatasetMetadata

mainframeDatasetRecordType

mainframeDatasetRuleset

mappingAlgorithm

maskingJob

monitoring

mountFilesystem

nonConformantDataSample

passwordVault

plugin

profileJob

profileSet

profileResultDatabase

Masking API (5.1.47)
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude
Connect to Cursor
Install MCP server on Cursor
Connect to VS Code
Install MCP server on VS Code

Request

Request

Request

Request