Mounted File Systems Controller Resource

The API allows you to list, view, edit and create mounted file systems.

GET /mounted-file-systems

Returns list of mounted file systems filtered by specified query parameters.

Request Parameters
name type description
direction query
filter query
mounted-backup query
nameLike query
orderBy query
page query
project-uuid query
size query
Response Body
media type data type description
application/json array of MountedFileSystemListRecord (JSON) list of mounted file systems filtered by specified query parameters

Example

Request
GET /mounted-file-systems
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
[ {
  "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67"
} ]

GET /mounted-file-systems/detailed

Returns detailed list of mounted file systems filtered by specified query parameters.

Request Parameters
name type description
direction query
filter query
mounted-backup query
nameLike query
orderBy query
page query
project-uuid query
size query
Response Body
media type data type description
application/json array of MountedFileSystemDetails (JSON) detailed list of mounted file systems filtered by specified query parameters

Example

Request
GET /mounted-file-systems/detailed
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
[ {
  "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67"
} ]

GET /mounted-file-systems/{guid}

Get a single mounted file system details.

Request Parameters
name type description
guid path specify local unique identifier for mounted file system (use by vProtect)
Response Body
media type data type description
application/json MountedFileSystemDetails (JSON) mounted file system details

Example

Request
GET /mounted-file-systems/{guid}
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67"
}

POST /mounted-file-systems/{guid}/download

Download specified files.

Request Parameters
name type description
guid path specify local unique identifier for mounted file system (use by vProtect)
Request Body
media type data type description
application/json FileDownloadRequest (JSON) specify paths to download files
Response Body
media type data type description
application/octet-stream object

Example

Request
POST /mounted-file-systems/{guid}/download
Content-Type: application/json
Accept: application/octet-stream

                
{ }
Response
HTTP/1.1 201 Created
Content-Type: application/octet-stream

                
...

POST /mounted-file-systems/{guid}/listing

Returns list of files specified by path.

Request Parameters
name type description
guid path specify local unique identifier for mounted file system (use by vProtect)
Request Body
media type data type description
application/json FileDetailsRequest (JSON) specify path from which files will be listed
Response Body
media type data type description
application/json array of FileDetailsListRecord (JSON) list of files specified by path

Example

Request
POST /mounted-file-systems/{guid}/listing
Content-Type: application/json
Accept: application/json

                
{ }
Response
HTTP/1.1 201 Created
Content-Type: application/json

                
[ {
  "name" : {
    "name" : "ENUM_NAME",
    "description" : "Enum description"
  }
} ]