Veeam Backup & Replication 13
REST API Reference
Related documents

Mount Servers

The Mount Servers section defines paths and operations for managing mount servers in your backup infrastructure. Mount servers are used in advanced restore operations (file restore, application item restore and Instant Recovery).

Get Mount Servers

The HTTP GET request to the /api/v1/backupInfrastructure/mountServers path allows you to get managed servers that have been assigned the mount server role.

Available to: Veeam Backup Administrator.

SecurityBearer
Request
query Parameters
skip
integer <int32>

Number of mount servers to skip.

limit
integer <int32>
Default: 200

Maximum number of mount servers to return.

orderColumn
string (EMountServersFiltersOrderColumn)

Sorts mount servers by one of the mount server parameters.

Enum: "Type" "WriteCacheFolder"
orderAsc
boolean

If true, sorts mount servers in the ascending order by the orderColumn parameter.

writeCacheFolderFilter
string

Filters mount servers by their write cache folder paths. To substitute one or more characters, use the asterisk (*) character at the beginning, at the end or both.

typeFilter
string (EMountServerType)

Filters mount servers by the mount server OS.

Enum: "windows" "linux"
isDefaultFilter
boolean

If true, shows only mount servers that are set as default.

header Parameters
x-api-version
required
string
Default: 1.3-rev0

Version and revision of the client REST API. Must be in the following format: <version>-<revision>.

Responses
200

OK

401

Unauthorized. The authorization header has been expected but not found (or found but is expired).

403

Forbidden. The user sending the request does not have adequate privileges to access one or more objects specified in the request.

404

Not found. No object was found with the path parameter specified in the request.

500

Internal server error. The request has been received but could not be completed because of an internal error at the server side.

get/api/v1/backupInfrastructure/mountServers
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "pagination": {
    }
}
Add Mount Server
The HTTP POST request to the /api/v1/backupInfrastructure/mountServers path allows you to assign a mount server role to an existing managed server.
Available to: Veeam Backup Administrator.


SecurityBearer 
Request 
header Parameters
x-api-version
required
string
 Default:  1.3-rev0
Version and revision of the client REST API. Must be in the following format: <version>-<revision>.


 
Request Body schema: application/json
required
hostId
required
string <uuid> 
Host ID. To get the ID, run the Get All Servers request.


 
object (MountServerOptionsModel) 
Mount server settings.


 
setAsDefault
boolean
If true, the mount server will be set as the default mount server.


 
Responses 
201
An Infrastructure session has been created to add a mount server. To check the progress, track the session state.


401
Unauthorized. The authorization header has been expected but not found (or found but is expired).


403
Forbidden. The user sending the request does not have adequate privileges to access one or more objects specified in the request.


404
Not found. No object was found with the path parameter specified in the request.


500
Internal server error. The request has been received but could not be completed because of an internal error at the server side.


post/api/v1/backupInfrastructure/mountServers
Request samples 
application/json
{
  • "type": "windows",
  • "hostid": "569e6a17-4691-4879-a835-1ea22325ec52",
  • "settings": {
    },
  • "isDefault": true
}
Response samples 
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "jobId": "9d222c6d-893e-4e79-8201-3c9ca16a0f39",
  • "sessionType": "Infrastructure",
  • "creationTime": "2019-08-24T14:15:22Z",
  • "endTime": "2019-08-24T14:15:22Z",
  • "state": "Stopped",
  • "progressPercent": 0,
  • "result": {
    },
  • "resourceId": "026d60bb-63a8-407e-bf67-01dcfc6022e6",
  • "resourceReference": "string",
  • "parentSessionId": "b1d7834e-fe2f-4cad-b0e5-ff5c5615f344",
  • "usn": 0,
  • "platformName": "VMware",
  • "platformId": "32a6e381-64f4-4911-86b6-3bf681b64d23",
  • "initiatedBy": "string"
}
Get Mount Server
The HTTP GET request to the /api/v1/backupInfrastructure/mountServers/{id} path allows you to get a mount server that has the specified id.
Available to: Veeam Backup Administrator.


SecurityBearer 
Request 
path Parameters
id
required
string <uuid> 
Mount server ID. The ID is the same as the ID of the managed server that was assigned a mount server role. To obtain the ID, use the Get Mount Servers request.


 
header Parameters
x-api-version
required
string
 Default:  1.3-rev0
Version and revision of the client REST API. Must be in the following format: <version>-<revision>.


 
Responses 
200
OK


401
Unauthorized. The authorization header has been expected but not found (or found but is expired).


403
Forbidden. The user sending the request does not have adequate privileges to access one or more objects specified in the request.


404
Not found. No object was found with the path parameter specified in the request.


500
Internal server error. The request has been received but could not be completed because of an internal error at the server side.


get/api/v1/backupInfrastructure/mountServers/{id}
Request samples 
Response samples 
application/json
{
  • "type": "windows",
  • "id": "569e6a17-4691-4879-a835-1ea22325ec52",
  • "settings": {
    },
  • "isDefault": true
}
Update Mount Server
The HTTP PUT request to the /api/v1/backupInfrastructure/mountServers/{id} path allows you to update the settings of a mount server that has the specified id.
Available to: Veeam Backup Administrator.


SecurityBearer 
Request 
path Parameters
id
required
string <uuid> 
Mount server ID. The ID is the same as the ID of the managed server that was assigned a mount server role. To obtain the ID, use the Get Mount Servers request.


 
header Parameters
x-api-version
required
string
 Default:  1.3-rev0
Version and revision of the client REST API. Must be in the following format: <version>-<revision>.


 
Request Body schema: application/json
required
id
required
string <uuid> 
Mount server ID. The ID is the same as the ID of the managed server that was assigned a mount server role.


 
type
string (EMountServerType) 
Mount server type.


 Enum: "windows" "linux"  
object (MountServerOptionsModel) 
Mount server settings.


 
isDefault
boolean
If true, the mount server is set as default.


 
Responses 
201
An Infrastructure session has been created to update the mount server settings. To check the progress, track the session state.


400
Bad request. This error is related to POST/PUT requests. The request body is malformed, incomplete or otherwise invalid.


401
Unauthorized. The authorization header has been expected but not found (or found but is expired).


403
Forbidden. The user sending the request does not have adequate privileges to access one or more objects specified in the request.


404
Not found. No object was found with the path parameter specified in the request.


500
Internal server error. The request has been received but could not be completed because of an internal error at the server side.


put/api/v1/backupInfrastructure/mountServers/{id}
Request samples 
application/json
{
  • "type": "windows",
  • "id": "569e6a17-4691-4879-a835-1ea22325ec52",
  • "settings": {
    },
  • "isDefault": true
}
Response samples 
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "jobId": "9d222c6d-893e-4e79-8201-3c9ca16a0f39",
  • "sessionType": "Infrastructure",
  • "creationTime": "2019-08-24T14:15:22Z",
  • "endTime": "2019-08-24T14:15:22Z",
  • "state": "Stopped",
  • "progressPercent": 0,
  • "result": {
    },
  • "resourceId": "026d60bb-63a8-407e-bf67-01dcfc6022e6",
  • "resourceReference": "string",
  • "parentSessionId": "b1d7834e-fe2f-4cad-b0e5-ff5c5615f344",
  • "usn": 0,
  • "platformName": "VMware",
  • "platformId": "32a6e381-64f4-4911-86b6-3bf681b64d23",
  • "initiatedBy": "string"
}
Get Default Mount Server
The HTTP GET request to the /api/v1/backupInfrastructure/mountServers/default path allows you to get default mount servers.
Available to: Veeam Backup Administrator.


SecurityBearer 
Request 
header Parameters
x-api-version
required
string
 Default:  1.3-rev0
Version and revision of the client REST API. Must be in the following format: <version>-<revision>.


 
Responses 
200
OK


401
Unauthorized. The authorization header has been expected but not found (or found but is expired).


403
Forbidden. The user sending the request does not have adequate privileges to access one or more objects specified in the request.


404
Not found. No object was found with the path parameter specified in the request.


500
Internal server error. The request has been received but could not be completed because of an internal error at the server side.


get/api/v1/backupInfrastructure/mountServers/default
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "pagination": {
    }
}
Set Default Mount Server
The HTTP POST request to the /api/v1/backupInfrastructure/mountServers/{id}/default path allows you to set a default mount server. After you set a default mount server, new repositories will be assigned this mount server by default, for targets with the same OS as the mount server.
For example, if you specify a Windows machine as a default mount server, all new repositories will use this mount server as the default mount server for advanced recovery operations to Windows machines.
 
Available to: Veeam Backup Administrator.


SecurityBearer 
Request 
path Parameters
id
required
string <uuid> 
Mount server ID. The ID is the same as the ID of the managed server that was assigned a mount server role. To obtain the ID, use the Get Mount Servers request.


 
header Parameters
x-api-version
required
string
 Default:  1.3-rev0
Version and revision of the client REST API. Must be in the following format: <version>-<revision>.


 
Responses 
201
Default mount server has been configured.


400
Bad request. This error is related to POST/PUT requests. The request body is malformed, incomplete or otherwise invalid.


401
Unauthorized. The authorization header has been expected but not found (or found but is expired).


403
Forbidden. The user sending the request does not have adequate privileges to access one or more objects specified in the request.


500
Internal server error. The request has been received but could not be completed because of an internal error at the server side.


post/api/v1/backupInfrastructure/mountServers/{id}/default
Request samples 
Response samples 
application/json
{
  • "type": "windows",
  • "id": "569e6a17-4691-4879-a835-1ea22325ec52",
  • "settings": {
    },
  • "isDefault": true
}