mountFilesystem

Get all mounts

Securityapi_key
Request
query Parameters
page_number
integer <int64>
Default: 1

The page number for which to get mount information. This will default to the first page if excluded

page_size
integer <int64>

The maximum number of objects to return. This will default to the DefaultApiPageSize setting if not provided

Responses
200

Success

400

Bad request

401

Unauthorized access

404

Not found

get/mount-filesystem
Response samples
application/json
{
  • "_pageInfo": {
    },
  • "responseList": [
    ]
}

Create filesystem mount

Securityapi_key
Request
Request Body schema: application/json
required

The filesystem to mount

mountName
required
string [ 1 .. 255 ] characters

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

hostAddress
required
string [ 1 .. 255 ] characters

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

mountPath
required
string [ 1 .. 4096 ] characters

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

type
required
string

The type of filesystem. This field cannot be changed.

Enum: "CIFS" "NFS3" "NFS4" "EXTERNAL"
connectOnStartup
boolean
Default: true

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.

options
string <= 4096 characters

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

Responses
200

Success

400

Bad request

401

Unauthorized access

404

Not found

409

Conflict

post/mount-filesystem
Request samples
application/json
{
  • "mountName": "my_mount",
  • "hostAddress": "some.host.com",
  • "mountPath": "/path/to/my/mount",
  • "type": "NFS4",
  • "options": "comma,delimited,options,list",
  • "connectOnStartup": true
}
Response samples
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

Securityapi_key
Request
path Parameters
mountID
required
integer <int32>

The ID of the mount to get

Responses
200

Success

400

Bad request

401

Unauthorized access

404

Not found

get/mount-filesystem/{mountID}
Response samples
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

Securityapi_key
Request
path Parameters
mountID
required
integer <int32>

The ID of the mount to update

Request Body schema: application/json
required

The updated filesystem

mountName
required
string [ 1 .. 255 ] characters

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

hostAddress
required
string [ 1 .. 255 ] characters

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

mountPath
required
string [ 1 .. 4096 ] characters

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

type
required
string

The type of filesystem. This field cannot be changed.

Enum: "CIFS" "NFS3" "NFS4" "EXTERNAL"
connectOnStartup
boolean
Default: true

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.

options
string <= 4096 characters

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

Responses
200

Success

400

Bad request

401

Unauthorized access

404

Not found

put/mount-filesystem/{mountID}
Request samples
application/json
{
  • "mountName": "my_mount",
  • "hostAddress": "some.host.com",
  • "mountPath": "/path/to/my/mount",
  • "type": "NFS4",
  • "options": "comma,delimited,options,list",
  • "connectOnStartup": true
}
Response samples
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

Securityapi_key
Request
path Parameters
mountID
required
integer <int32>

The ID of the mount to delete

Responses
200

Success

400

Bad request

401

Unauthorized access

404

Not found

delete/mount-filesystem/{mountID}

Connect filesystem mount

Securityapi_key
Request
path Parameters
mountID
required
integer <int32>

The ID of the mount to connect

Responses
200

Success

400

Bad request

401

Unauthorized access

404

Not found

put/mount-filesystem/{mountID}/connect
Response samples
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

Securityapi_key
Request
path Parameters
mountID
required
integer <int32>

The ID of the mount to disconnect

Responses
200

Success

400

Bad request

401

Unauthorized access

404

Not found

put/mount-filesystem/{mountID}/disconnect
Response samples
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

Securityapi_key
Request
path Parameters
mountID
required
integer <int32>

The ID of the mount to update

Request Body schema: application/json
required

The updated filesystem

mountName
required
string [ 1 .. 255 ] characters

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

hostAddress
required
string [ 1 .. 255 ] characters

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

mountPath
required
string [ 1 .. 4096 ] characters

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

type
required
string

The type of filesystem. This field cannot be changed.

Enum: "CIFS" "NFS3" "NFS4" "EXTERNAL"
connectOnStartup
boolean
Default: true

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.

options
string <= 4096 characters

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

Responses
200

Success

400

Bad request

401

Unauthorized access

404

Not found

put/mount-filesystem/{mountID}/remount
Request samples
application/json
{
  • "mountName": "my_mount",
  • "hostAddress": "some.host.com",
  • "mountPath": "/path/to/my/mount",
  • "type": "NFS4",
  • "options": "comma,delimited,options,list",
  • "connectOnStartup": true
}
Response samples
application/json
{
  • "mountName": "my_mount",
  • "hostAddress": "some.host.com",
  • "mountPath": "/path/to/my/mount",
  • "type": "NFS4",
  • "options": "comma,delimited,options,list",
  • "connectOnStartup": true
}
➔ Next to nonConformantDataSample