Mounted Backups Controller Resource

The API allows you to list, view and remove mounted backups.

GET /mounted-backups

Returns a list of mounted backups filtered by specified query parameters.

Request Parameters
name type description constraints
backup query  
direction query  
filter query  
finished-mount query boolean
mode query "AUTO" or "CLOUD_DOWNLOAD" or "CLOUD_PST_DOWNLOAD" or "INSTANT_RESTORE" or "ISCSI" or "MANUAL" or "OS_DOWNLOAD"
nameLike query  
node query  
orderBy query  
page query  
project-uuid query  
protected-entity query  
protected-entity-type query "APP" or "CLOUD" or "CLOUD_GROUP" or "CLOUD_SITE" or "CLOUD_TEAMS" or "CLOUD_USER" or "OS" or "OS_AGENT" or "STORAGE" or "VM"
size query  
Response Body
media type data type description
application/json array of MountedBackupListRecord (JSON) list of mounted backups filtered by specified query parameters

Example

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

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

                
[ {
  "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
  "mode" : {
    "name" : "ENUM_NAME",
    "description" : "Enum description"
  }
} ]

GET /mounted-backups/{guid}

Get a single mounted backup.

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

Example

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

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

                
{
  "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
  "mode" : {
    "name" : "ENUM_NAME",
    "description" : "Enum description"
  }
}

PUT /mounted-backups/{guid}

Change mounted backup details.

Request Parameters
name type description
guid path specify local unique identifier for mounted backup (used by vProtect)
Request Body
media type data type description
application/json MountedBackupUpdateRequest (JSON) specify mounted backup details to update
Response Body
media type data type description
application/json MountedBackupDetails (JSON) updated details of mounted backup

Example

Request
PUT /mounted-backups/{guid}
Content-Type: application/json
Accept: application/json

                
{ }
Response
HTTP/1.1 204 No Content
Content-Type: application/json

                
{
  "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
  "mode" : {
    "name" : "ENUM_NAME",
    "description" : "Enum description"
  }
}

PUT /mounted-backups/{guid}/mounted-restored-vmid

Update mounted backup restored vm uuid.

Request Parameters
name type description
guid path specify local unique identifier for mounted backup (used by vProtect)
Request Body
media type data type description
application/json string (JSON) uuid restored Vm
Response Body
media type data type description
application/json MountedBackupDetails (JSON) updated details of mounted backup

Example

Request
PUT /mounted-backups/{guid}/mounted-restored-vmid
Content-Type: application/json
Accept: application/json

                
...
Response
HTTP/1.1 204 No Content
Content-Type: application/json

                
{
  "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
  "mode" : {
    "name" : "ENUM_NAME",
    "description" : "Enum description"
  }
}