Skip to content
/
Update filesystem mount

Masking API (5.1.45)

Schema for the Continuous Compliance Engine API

Download OpenAPI description
CC Engine APIs (2025.5.0.0).json
CC Engine APIs (2025.5.0.0).yaml
Languages
Servers
Mock server
https://help-api.delphix.com/_mock/continuous-compliance-engine/2025.5.0.0/cc-engine-apis-2025.5.0.0
https://help-api.delphix.com/masking/api/v5.1.45

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

Get all mounts

Request

Security
api_key
Query
page_numberinteger(int64)

The page number for which to get mount information. 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.5.0.0/cc-engine-apis-2025.5.0.0/mount-filesystem?page_number=1&page_size=0' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Success

Bodyapplication/json
_pageInfoobject(PageInfo)
responseListArray of objects(MountInformation)
Example: [{"mountName":"my_mount","hostAddress":"some.host.com","mountPath":"/path/to/my/mount","type":"NFS4","options":"comma,delimited,options,list","connectOnStartup":true}]
Response
application/json
{
  "_pageInfo": {
    "numberOnPage": 0,
    "total": 0
  },
  "responseList": [
    { … }
  ]
}

Create filesystem mount

Request

Security
api_key
Bodyapplication/jsonrequired

The filesystem to mount

mountNamestring[ 1 .. 255 ] charactersrequired

The name of the mount. This field must be unique.

Example: "my_mount"
hostAddressstring[ 1 .. 255 ] charactersrequired

The host address of the server. This field cannot be changed.

Example: "some.host.com"
mountPathstring[ 1 .. 4096 ] charactersrequired

The path to the directory on the filesystem to mount. This field cannot be changed.

Example: "/path/to/my/mount"
typestringrequired

The type of filesystem. This field cannot be changed.

Enum"CIFS""NFS3""NFS4""EXTERNAL"
Example: "NFS4"
connectOnStartupboolean

This field determines whether this filesystem will be automatically connected (mounted) on startup of the masking engine. Note that all mounts will be disconnected on shutdown of the masking engine.

Default true
Example: true
optionsstring<= 4096 characters

The options for mount. The endpoint will return all default options and user specified options.

Example: "comma,delimited,options,list"
curl -i -X POST \
  https://help-api.delphix.com/_mock/continuous-compliance-engine/2025.5.0.0/cc-engine-apis-2025.5.0.0/mount-filesystem \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "mountName": "my_mount",
    "hostAddress": "some.host.com",
    "mountPath": "/path/to/my/mount",
    "type": "NFS4",
    "options": "comma,delimited,options,list",
    "connectOnStartup": true
  }'

Responses

Success

Bodyapplication/json
mountIdinteger(int32)read-only

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

mountNamestring[ 1 .. 255 ] charactersrequired

The name of the mount. This field must be unique.

Example: "my_mount"
hostAddressstring[ 1 .. 255 ] charactersrequired

The host address of the server. This field cannot be changed.

Example: "some.host.com"
mountPathstring[ 1 .. 4096 ] charactersrequired

The path to the directory on the filesystem to mount. This field cannot be changed.

Example: "/path/to/my/mount"
typestringrequired

The type of filesystem. This field cannot be changed.

Enum"CIFS""NFS3""NFS4""EXTERNAL"
Example: "NFS4"
connectOnStartupboolean

This field determines whether this filesystem will be automatically connected (mounted) on startup of the masking engine. Note that all mounts will be disconnected on shutdown of the masking engine.

Default true
Example: true
optionsstring<= 4096 characters

The options for mount. The endpoint will return all default options and user specified options.

Example: "comma,delimited,options,list"
statusstringread-only

The connection status for mount. This field is automatically managed by the masking engine.

Enum"ACTIVE""DISCONNECTED"
mountDevicestring[ 1 .. 255 ] charactersread-only

The mounted device IP/URI and the local path on that device. Automatically auto-discovered in containerized masking environment. The field is empty when running in the Delphix Virtual Appliance. This field cannot be changed.

localMountPathstring[ 1 .. 4096 ] charactersread-only

The path to the mounted local directory on the containerized masking engine. Automatically auto-discovered in containerized masking environment. The field is empty when running in the Delphix Virtual Appliance. This field cannot be changed.

Response
application/json
{
  "mountName": "my_mount",
  "hostAddress": "some.host.com",
  "mountPath": "/path/to/my/mount",
  "type": "NFS4",
  "options": "comma,delimited,options,list",
  "connectOnStartup": true
}

Get mount by ID

Request

Security
api_key
Path
mountIDinteger(int32)required

The ID of the mount to get

curl -i -X GET \
  'https://help-api.delphix.com/_mock/continuous-compliance-engine/2025.5.0.0/cc-engine-apis-2025.5.0.0/mount-filesystem/{mountID}' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Success

Bodyapplication/json
mountIdinteger(int32)read-only

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

mountNamestring[ 1 .. 255 ] charactersrequired

The name of the mount. This field must be unique.

Example: "my_mount"
hostAddressstring[ 1 .. 255 ] charactersrequired

The host address of the server. This field cannot be changed.

Example: "some.host.com"
mountPathstring[ 1 .. 4096 ] charactersrequired

The path to the directory on the filesystem to mount. This field cannot be changed.

Example: "/path/to/my/mount"
typestringrequired

The type of filesystem. This field cannot be changed.

Enum"CIFS""NFS3""NFS4""EXTERNAL"
Example: "NFS4"
connectOnStartupboolean

This field determines whether this filesystem will be automatically connected (mounted) on startup of the masking engine. Note that all mounts will be disconnected on shutdown of the masking engine.

Default true
Example: true
optionsstring<= 4096 characters

The options for mount. The endpoint will return all default options and user specified options.

Example: "comma,delimited,options,list"
statusstringread-only

The connection status for mount. This field is automatically managed by the masking engine.

Enum"ACTIVE""DISCONNECTED"
mountDevicestring[ 1 .. 255 ] charactersread-only

The mounted device IP/URI and the local path on that device. Automatically auto-discovered in containerized masking environment. The field is empty when running in the Delphix Virtual Appliance. This field cannot be changed.

localMountPathstring[ 1 .. 4096 ] charactersread-only

The path to the mounted local directory on the containerized masking engine. Automatically auto-discovered in containerized masking environment. The field is empty when running in the Delphix Virtual Appliance. This field cannot be changed.

Response
application/json
{
  "mountName": "my_mount",
  "hostAddress": "some.host.com",
  "mountPath": "/path/to/my/mount",
  "type": "NFS4",
  "options": "comma,delimited,options,list",
  "connectOnStartup": true
}

Update filesystem mount

Request

Security
api_key
Path
mountIDinteger(int32)required

The ID of the mount to update

Bodyapplication/jsonrequired

The updated filesystem

mountNamestring[ 1 .. 255 ] charactersrequired

The name of the mount. This field must be unique.

Example: "my_mount"
hostAddressstring[ 1 .. 255 ] charactersrequired

The host address of the server. This field cannot be changed.

Example: "some.host.com"
mountPathstring[ 1 .. 4096 ] charactersrequired

The path to the directory on the filesystem to mount. This field cannot be changed.

Example: "/path/to/my/mount"
typestringrequired

The type of filesystem. This field cannot be changed.

Enum"CIFS""NFS3""NFS4""EXTERNAL"
Example: "NFS4"
connectOnStartupboolean

This field determines whether this filesystem will be automatically connected (mounted) on startup of the masking engine. Note that all mounts will be disconnected on shutdown of the masking engine.

Default true
Example: true
optionsstring<= 4096 characters

The options for mount. The endpoint will return all default options and user specified options.

Example: "comma,delimited,options,list"
curl -i -X PUT \
  'https://help-api.delphix.com/_mock/continuous-compliance-engine/2025.5.0.0/cc-engine-apis-2025.5.0.0/mount-filesystem/{mountID}' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "mountName": "my_mount",
    "hostAddress": "some.host.com",
    "mountPath": "/path/to/my/mount",
    "type": "NFS4",
    "options": "comma,delimited,options,list",
    "connectOnStartup": true
  }'

Responses

Success

Bodyapplication/json
mountIdinteger(int32)read-only

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

mountNamestring[ 1 .. 255 ] charactersrequired

The name of the mount. This field must be unique.

Example: "my_mount"
hostAddressstring[ 1 .. 255 ] charactersrequired

The host address of the server. This field cannot be changed.

Example: "some.host.com"
mountPathstring[ 1 .. 4096 ] charactersrequired

The path to the directory on the filesystem to mount. This field cannot be changed.

Example: "/path/to/my/mount"
typestringrequired

The type of filesystem. This field cannot be changed.

Enum"CIFS""NFS3""NFS4""EXTERNAL"
Example: "NFS4"
connectOnStartupboolean

This field determines whether this filesystem will be automatically connected (mounted) on startup of the masking engine. Note that all mounts will be disconnected on shutdown of the masking engine.

Default true
Example: true
optionsstring<= 4096 characters

The options for mount. The endpoint will return all default options and user specified options.

Example: "comma,delimited,options,list"
statusstringread-only

The connection status for mount. This field is automatically managed by the masking engine.

Enum"ACTIVE""DISCONNECTED"
mountDevicestring[ 1 .. 255 ] charactersread-only

The mounted device IP/URI and the local path on that device. Automatically auto-discovered in containerized masking environment. The field is empty when running in the Delphix Virtual Appliance. This field cannot be changed.

localMountPathstring[ 1 .. 4096 ] charactersread-only

The path to the mounted local directory on the containerized masking engine. Automatically auto-discovered in containerized masking environment. The field is empty when running in the Delphix Virtual Appliance. This field cannot be changed.

Response
application/json
{
  "mountName": "my_mount",
  "hostAddress": "some.host.com",
  "mountPath": "/path/to/my/mount",
  "type": "NFS4",
  "options": "comma,delimited,options,list",
  "connectOnStartup": true
}

Delete filesystem mount

Request

Security
api_key
Path
mountIDinteger(int32)required

The ID of the mount to delete

curl -i -X DELETE \
  'https://help-api.delphix.com/_mock/continuous-compliance-engine/2025.5.0.0/cc-engine-apis-2025.5.0.0/mount-filesystem/{mountID}' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Success

Connect filesystem mount

Request

Security
api_key
Path
mountIDinteger(int32)required

The ID of the mount to connect

curl -i -X PUT \
  'https://help-api.delphix.com/_mock/continuous-compliance-engine/2025.5.0.0/cc-engine-apis-2025.5.0.0/mount-filesystem/{mountID}/connect' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Success

Bodyapplication/json
mountIdinteger(int32)read-only

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

mountNamestring[ 1 .. 255 ] charactersrequired

The name of the mount. This field must be unique.

Example: "my_mount"
hostAddressstring[ 1 .. 255 ] charactersrequired

The host address of the server. This field cannot be changed.

Example: "some.host.com"
mountPathstring[ 1 .. 4096 ] charactersrequired

The path to the directory on the filesystem to mount. This field cannot be changed.

Example: "/path/to/my/mount"
typestringrequired

The type of filesystem. This field cannot be changed.

Enum"CIFS""NFS3""NFS4""EXTERNAL"
Example: "NFS4"
connectOnStartupboolean

This field determines whether this filesystem will be automatically connected (mounted) on startup of the masking engine. Note that all mounts will be disconnected on shutdown of the masking engine.

Default true
Example: true
optionsstring<= 4096 characters

The options for mount. The endpoint will return all default options and user specified options.

Example: "comma,delimited,options,list"
statusstringread-only

The connection status for mount. This field is automatically managed by the masking engine.

Enum"ACTIVE""DISCONNECTED"
mountDevicestring[ 1 .. 255 ] charactersread-only

The mounted device IP/URI and the local path on that device. Automatically auto-discovered in containerized masking environment. The field is empty when running in the Delphix Virtual Appliance. This field cannot be changed.

localMountPathstring[ 1 .. 4096 ] charactersread-only

The path to the mounted local directory on the containerized masking engine. Automatically auto-discovered in containerized masking environment. The field is empty when running in the Delphix Virtual Appliance. This field cannot be changed.

Response
application/json
{
  "mountName": "my_mount",
  "hostAddress": "some.host.com",
  "mountPath": "/path/to/my/mount",
  "type": "NFS4",
  "options": "comma,delimited,options,list",
  "connectOnStartup": true
}

Disconnect filesystem mount

Request

Security
api_key
Path
mountIDinteger(int32)required

The ID of the mount to disconnect

curl -i -X PUT \
  'https://help-api.delphix.com/_mock/continuous-compliance-engine/2025.5.0.0/cc-engine-apis-2025.5.0.0/mount-filesystem/{mountID}/disconnect' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Success

Bodyapplication/json
mountIdinteger(int32)read-only

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

mountNamestring[ 1 .. 255 ] charactersrequired

The name of the mount. This field must be unique.

Example: "my_mount"
hostAddressstring[ 1 .. 255 ] charactersrequired

The host address of the server. This field cannot be changed.

Example: "some.host.com"
mountPathstring[ 1 .. 4096 ] charactersrequired

The path to the directory on the filesystem to mount. This field cannot be changed.

Example: "/path/to/my/mount"
typestringrequired

The type of filesystem. This field cannot be changed.

Enum"CIFS""NFS3""NFS4""EXTERNAL"
Example: "NFS4"
connectOnStartupboolean

This field determines whether this filesystem will be automatically connected (mounted) on startup of the masking engine. Note that all mounts will be disconnected on shutdown of the masking engine.

Default true
Example: true
optionsstring<= 4096 characters

The options for mount. The endpoint will return all default options and user specified options.

Example: "comma,delimited,options,list"
statusstringread-only

The connection status for mount. This field is automatically managed by the masking engine.

Enum"ACTIVE""DISCONNECTED"
mountDevicestring[ 1 .. 255 ] charactersread-only

The mounted device IP/URI and the local path on that device. Automatically auto-discovered in containerized masking environment. The field is empty when running in the Delphix Virtual Appliance. This field cannot be changed.

localMountPathstring[ 1 .. 4096 ] charactersread-only

The path to the mounted local directory on the containerized masking engine. Automatically auto-discovered in containerized masking environment. The field is empty when running in the Delphix Virtual Appliance. This field cannot be changed.

Response
application/json
{
  "mountName": "my_mount",
  "hostAddress": "some.host.com",
  "mountPath": "/path/to/my/mount",
  "type": "NFS4",
  "options": "comma,delimited,options,list",
  "connectOnStartup": true
}

Remount filesystem mount

Request

Security
api_key
Path
mountIDinteger(int32)required

The ID of the mount to update

Bodyapplication/jsonrequired

The updated filesystem

mountNamestring[ 1 .. 255 ] charactersrequired

The name of the mount. This field must be unique.

Example: "my_mount"
hostAddressstring[ 1 .. 255 ] charactersrequired

The host address of the server. This field cannot be changed.

Example: "some.host.com"
mountPathstring[ 1 .. 4096 ] charactersrequired

The path to the directory on the filesystem to mount. This field cannot be changed.

Example: "/path/to/my/mount"
typestringrequired

The type of filesystem. This field cannot be changed.

Enum"CIFS""NFS3""NFS4""EXTERNAL"
Example: "NFS4"
connectOnStartupboolean

This field determines whether this filesystem will be automatically connected (mounted) on startup of the masking engine. Note that all mounts will be disconnected on shutdown of the masking engine.

Default true
Example: true
optionsstring<= 4096 characters

The options for mount. The endpoint will return all default options and user specified options.

Example: "comma,delimited,options,list"
curl -i -X PUT \
  'https://help-api.delphix.com/_mock/continuous-compliance-engine/2025.5.0.0/cc-engine-apis-2025.5.0.0/mount-filesystem/{mountID}/remount' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "mountName": "my_mount",
    "hostAddress": "some.host.com",
    "mountPath": "/path/to/my/mount",
    "type": "NFS4",
    "options": "comma,delimited,options,list",
    "connectOnStartup": true
  }'

Responses

Success

Bodyapplication/json
mountIdinteger(int32)read-only

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

mountNamestring[ 1 .. 255 ] charactersrequired

The name of the mount. This field must be unique.

Example: "my_mount"
hostAddressstring[ 1 .. 255 ] charactersrequired

The host address of the server. This field cannot be changed.

Example: "some.host.com"
mountPathstring[ 1 .. 4096 ] charactersrequired

The path to the directory on the filesystem to mount. This field cannot be changed.

Example: "/path/to/my/mount"
typestringrequired

The type of filesystem. This field cannot be changed.

Enum"CIFS""NFS3""NFS4""EXTERNAL"
Example: "NFS4"
connectOnStartupboolean

This field determines whether this filesystem will be automatically connected (mounted) on startup of the masking engine. Note that all mounts will be disconnected on shutdown of the masking engine.

Default true
Example: true
optionsstring<= 4096 characters

The options for mount. The endpoint will return all default options and user specified options.

Example: "comma,delimited,options,list"
statusstringread-only

The connection status for mount. This field is automatically managed by the masking engine.

Enum"ACTIVE""DISCONNECTED"
mountDevicestring[ 1 .. 255 ] charactersread-only

The mounted device IP/URI and the local path on that device. Automatically auto-discovered in containerized masking environment. The field is empty when running in the Delphix Virtual Appliance. This field cannot be changed.

localMountPathstring[ 1 .. 4096 ] charactersread-only

The path to the mounted local directory on the containerized masking engine. Automatically auto-discovered in containerized masking environment. The field is empty when running in the Delphix Virtual Appliance. This field cannot be changed.

Response
application/json
{
  "mountName": "my_mount",
  "hostAddress": "some.host.com",
  "mountPath": "/path/to/my/mount",
  "type": "NFS4",
  "options": "comma,delimited,options,list",
  "connectOnStartup": true
}

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