Veeam Backup for Microsoft 365 8
REST API Reference
Related documents

Backup Proxy Servers

The /Proxies resource collection represents backup proxy servers in the Veeam Backup for Microsoft 365 infrastructure.

Get Backup Proxy Servers

Returns a collection of backup proxy servers.

SecurityBearer
Request
query Parameters
limit
integer <int32>

Limits the maximum number of items that the server will return on a page. The maximum supported number of items per page is 10,000. The default value is 30.

offset
integer <int32>

Excludes from a response page the first N items of a collection resource. The default value is 0.

Responses
200

OK

default

Operation failure response.

get/v8/Proxies
Request samples 
Response samples 
application/json
{
  • "offset": 0,
  • "limit": 0,
  • "setId": "83e19bc1-5428-42b5-88ea-b28354e481f3",
  • "results": [
    ],
  • "_links": {
    }
}
Add Backup Proxy Server
Adds a backup proxy server to the Veeam Backup for Microsoft 365 infrastructure.


x-codegen-request-body-name:  proxy
SecurityBearer 
Request 
Request Body schema: application/json
required
useDomainNetwork
boolean or null
Defines the type of the backup proxy server to add. The following values are available: 
     
  • true - domain backup proxy, that is, a backup proxy server that resides in the same domain as the Veeam Backup for Microsoft 365 server or in a trusted domain.
    •  
  • false - workgroup backup proxy, that is, a backup proxy server that resides in a workgroup.
    •  
 If you omit this property, a workgroup backup proxy will be added.


 
useInternetProxy
boolean or null
Defines whether Veeam Backup for Microsoft 365 will use an internet proxy server to process backup and backup copy jobs.


 
internetProxyType
string or null
Specifies the type of the internet proxy server. The following types are available: 
     
  • FromManagementServer - the internet proxy server uses connection settings from the Veeam Backup for Microsoft 365 server.
    •  
  • Custom - the internet proxy server uses connection settings configured on the Veeam Backup for Microsoft 365 proxy.
    •  


Note: The useInternetProxy property value must be set to true.


 Enum: "FromManagementServer" "Custom"  
object (RESTInternetProxySettingsFromClient) 
 
operatingSystem
string (RESTProxyOperatingSystem) 
Type of the operating system that the backup proxy server runs.


 Enum: "Windows" "Linux"  
object (RESTSshSettingsFromClient) 
Specifies credentials to access the Linux-based backup proxy server.


 
id
string or null <uuid> 
Specifies the ID of the backup proxy server.


 
hostName
string
Specifies the DNS name or IP address of the backup proxy server.


 
description
string
Specifies a description of the backup proxy server.


 
port
integer or null <int32> 
Specifies the port number to connect to the backup proxy server. The default port is 9193.


 
username
string
Specifies the user name to access the backup proxy server.


 
password
string <password>  (SecureString) 
Specifies a password.


 
serviceAccountName
string or null
Specifies the service account to run Veeam Backup for Microsoft 365 Proxy Service.


 
serviceAccountPassword
string <password>  (SecureString) 
Specifies a password.


 
createServiceAccount
boolean
Defines whether Veeam Backup for Microsoft 365 will create the service account.


 
enableNetworkThrottling
boolean or null
Defines whether Veeam Backup for Microsoft 365 will limit the network bandwidth for performance optimization. Use the throttlingValue property to set the network throttling value.


 
throttlingValue
integer or null <int64> 
Specifies the network bandwidth limit value.


Note: The enableNetworkThrottling property value must be set to true. Otherwise, the network bandwidth limit value will not be applied.


 
throttlingUnit
string or null
Specifies the measuring unit for the network bandwidth limit.


Note: The enableNetworkThrottling property value must be set to true.


 Enum: "Mbps" "MBs" "KBs"  
attachUsedProxy
boolean or null
Adds a backup proxy server that is already managed by another Veeam Backup for Microsoft 365 server. Defines whether Veeam Backup for Microsoft 365 will take ownership of the backup proxy server and add it to the backup infrastructure.


 
Responses 
201
Created


default
Operation failure response.


post/v8/Proxies
Request samples 
application/json
{
  • "useDomainNetwork": true,
  • "useInternetProxy": true,
  • "internetProxyType": "FromManagementServer",
  • "internetProxySettings": {
    },
  • "operatingSystem": "Windows",
  • "sshSettings": {
    },
  • "id": "00000000-0000-0000-0000-000000000000",
  • "hostName": "string",
  • "description": "string",
  • "port": 0,
  • "username": "string",
  • "password": "pa$$word",
  • "serviceAccountName": "string",
  • "serviceAccountPassword": "pa$$word",
  • "createServiceAccount": true,
  • "enableNetworkThrottling": true,
  • "throttlingValue": 0,
  • "throttlingUnit": "Mbps",
  • "attachUsedProxy": true
}
Response samples 
application/json
{
  • "type": "Local",
  • "useInternetProxy": true,
  • "internetProxyType": "FromManagementServer",
  • "operatingSystem": "Windows",
  • "internetProxySettings": {
    },
  • "id": "00000000-0000-0000-0000-000000000000",
  • "proxyPoolId": "00000000-0000-0000-0000-000000000000",
  • "hostName": "string",
  • "fqdn": "string",
  • "description": "string",
  • "port": 0,
  • "enableNetworkThrottling": true,
  • "throttlingValue": 0,
  • "throttlingUnit": "Mbps",
  • "status": "Online",
  • "maintenanceModeState": "Disabled",
  • "cpuUsagePercent": 0,
  • "memoryUsagePercent": 0,
  • "version": "string",
  • "serviceAccount": "string",
  • "role": [
    ],
  • "_links": {
    }
}
Get Backup Proxy Server
Returns a resource representation of a backup proxy server with the specified ID.


SecurityBearer 
Request 
path Parameters
proxyId
required
string <uuid> 
Specifies the identification number of the backup proxy server. For more information on how to get this parameter, see Get Backup Proxy Servers.


 
Responses 
200
OK


default
Operation failure response.


get/v8/Proxies/{proxyId}
Request samples 
Response samples 
application/json
{
  • "type": "Local",
  • "useInternetProxy": true,
  • "internetProxyType": "FromManagementServer",
  • "operatingSystem": "Windows",
  • "internetProxySettings": {
    },
  • "id": "00000000-0000-0000-0000-000000000000",
  • "proxyPoolId": "00000000-0000-0000-0000-000000000000",
  • "hostName": "string",
  • "fqdn": "string",
  • "description": "string",
  • "port": 0,
  • "enableNetworkThrottling": true,
  • "throttlingValue": 0,
  • "throttlingUnit": "Mbps",
  • "status": "Online",
  • "maintenanceModeState": "Disabled",
  • "cpuUsagePercent": 0,
  • "memoryUsagePercent": 0,
  • "version": "string",
  • "serviceAccount": "string",
  • "role": [
    ],
  • "_links": {
    }
}
Edit Backup Proxy Server Settings
Modifies settings of a backup proxy server with the specified ID.


x-codegen-request-body-name:  proxy
SecurityBearer 
Request 
path Parameters
proxyId
required
string <uuid> 
Specifies the identification number of the backup proxy server. For more information on how to get this parameter, see Get Backup Proxy Servers.


 
Request Body schema: application/json
required
useDomainNetwork
boolean or null
Defines the type of the backup proxy server to add. The following values are available: 
     
  • true - domain backup proxy, that is, a backup proxy server that resides in the same domain as the Veeam Backup for Microsoft 365 server or in a trusted domain.
    •  
  • false - workgroup backup proxy, that is, a backup proxy server that resides in a workgroup.
    •  
 If you omit this property, a workgroup backup proxy will be added.


 
useInternetProxy
boolean or null
Defines whether Veeam Backup for Microsoft 365 will use an internet proxy server to process backup and backup copy jobs.


 
internetProxyType
string or null
Specifies the type of the internet proxy server. The following types are available: 
     
  • FromManagementServer - the internet proxy server uses connection settings from the Veeam Backup for Microsoft 365 server.
    •  
  • Custom - the internet proxy server uses connection settings configured on the Veeam Backup for Microsoft 365 proxy.
    •  


Note: The useInternetProxy property value must be set to true.


 Enum: "FromManagementServer" "Custom"  
object (RESTInternetProxySettingsFromClient) 
 
operatingSystem
string (RESTProxyOperatingSystem) 
Type of the operating system that the backup proxy server runs.


 Enum: "Windows" "Linux"  
object (RESTSshSettingsFromClient) 
Specifies credentials to access the Linux-based backup proxy server.


 
id
string or null <uuid> 
Specifies the ID of the backup proxy server.


 
hostName
string
Specifies the DNS name or IP address of the backup proxy server.


 
description
string
Specifies a description of the backup proxy server.


 
port
integer or null <int32> 
Specifies the port number to connect to the backup proxy server. The default port is 9193.


 
username
string
Specifies the user name to access the backup proxy server.


 
password
string <password>  (SecureString) 
Specifies a password.


 
serviceAccountName
string or null
Specifies the service account to run Veeam Backup for Microsoft 365 Proxy Service.


 
serviceAccountPassword
string <password>  (SecureString) 
Specifies a password.


 
createServiceAccount
boolean
Defines whether Veeam Backup for Microsoft 365 will create the service account.


 
enableNetworkThrottling
boolean or null
Defines whether Veeam Backup for Microsoft 365 will limit the network bandwidth for performance optimization. Use the throttlingValue property to set the network throttling value.


 
throttlingValue
integer or null <int64> 
Specifies the network bandwidth limit value.


Note: The enableNetworkThrottling property value must be set to true. Otherwise, the network bandwidth limit value will not be applied.


 
throttlingUnit
string or null
Specifies the measuring unit for the network bandwidth limit.


Note: The enableNetworkThrottling property value must be set to true.


 Enum: "Mbps" "MBs" "KBs"  
attachUsedProxy
boolean or null
Adds a backup proxy server that is already managed by another Veeam Backup for Microsoft 365 server. Defines whether Veeam Backup for Microsoft 365 will take ownership of the backup proxy server and add it to the backup infrastructure.


 
Responses 
204
No Content


default
Operation failure response.


put/v8/Proxies/{proxyId}
Request samples 
application/json
{
  • "useDomainNetwork": true,
  • "useInternetProxy": true,
  • "internetProxyType": "FromManagementServer",
  • "internetProxySettings": {
    },
  • "operatingSystem": "Windows",
  • "sshSettings": {
    },
  • "id": "00000000-0000-0000-0000-000000000000",
  • "hostName": "string",
  • "description": "string",
  • "port": 0,
  • "username": "string",
  • "password": "pa$$word",
  • "serviceAccountName": "string",
  • "serviceAccountPassword": "pa$$word",
  • "createServiceAccount": true,
  • "enableNetworkThrottling": true,
  • "throttlingValue": 0,
  • "throttlingUnit": "Mbps",
  • "attachUsedProxy": true
}
Response samples 
application/json
{
  • "message": "string",
  • "errorCode": "ProxyOffline",
  • "stackTrace": "string"
}
Rescan Backup Proxy Server
Rescans a backup proxy server with the specified ID.


SecurityBearer 
Request 
path Parameters
proxyId
required
string <uuid> 
Specifies the identification number of the backup proxy server. For more information on how to get this parameter, see Get Backup Proxy Servers.


 
Responses 
204
No Content


default
Operation failure response.


post/v8/Proxies/{proxyId}/Rescan
Request samples 
Response samples 
application/json
{
  • "message": "string",
  • "errorCode": "ProxyOffline",
  • "stackTrace": "string"
}
Enable Maintenance Mode for Backup Proxy Server
Enables maintenance mode for a backup proxy server with the specified ID.


SecurityBearer 
Request 
path Parameters
proxyId
required
string <uuid> 
Specifies the identification number of the backup proxy server. For more information on how to get this parameter, see Get Backup Proxy Servers.


 
Request Body schema: application/json
required
object (RESTSshSettingsFromClient) 
Specifies credentials to access the Linux-based backup proxy server.


 
username
string
Specifies a user name to access the Windows-based backup proxy server.


 
password
string <password>  (SecureString) 
Specifies a password.


 
Responses 
204
No Content


default
Operation failure response.


post/v8/Proxies/{proxyId}/maintenance/enable
Request samples 
application/json
{
  • "sshSettings": {
    },
  • "username": "string",
  • "password": "pa$$word"
}
Response samples 
application/json
{
  • "message": "string",
  • "errorCode": "ProxyOffline",
  • "stackTrace": "string"
}
Disable Maintenance Mode for Backup Proxy Server
Disables maintenance mode for a backup proxy server with the specified ID.


SecurityBearer 
Request 
path Parameters
proxyId
required
string <uuid> 
Specifies the identification number of the backup proxy server. For more information on how to get this parameter, see Get Backup Proxy Servers.


 
Request Body schema: application/json
required
object (RESTSshSettingsFromClient) 
Specifies credentials to access the Linux-based backup proxy server.


 
username
string
Specifies a user name to access the Windows-based backup proxy server.


 
password
string <password>  (SecureString) 
Specifies a password.


 
Responses 
204
No Content


default
Operation failure response.


post/v8/Proxies/{proxyId}/maintenance/disable
Request samples 
application/json
{
  • "sshSettings": {
    },
  • "username": "string",
  • "password": "pa$$word"
}
Response samples 
application/json
{
  • "message": "string",
  • "errorCode": "ProxyOffline",
  • "stackTrace": "string"
}
Remove Backup Proxy Server
Removes a backup proxy server with the specified ID from the Veeam Backup for Microsoft 365 infrastructure.


x-codegen-request-body-name:  options
SecurityBearer 
Request 
path Parameters
proxyId
required
string <uuid> 
Specifies the identification number of the backup proxy server. For more information on how to get this parameter, see Get Backup Proxy Servers.


 
Request Body schema: application/json
required
force
boolean
Defines whether Veeam Backup for Microsoft 365 must remove the backup proxy server in the following cases: 
     
  • Veeam Backup for Microsoft 365 cannot connect to the backup proxy server.
    •  
  • The backup proxy server is in use by Veeam Backup for Microsoft 365.
    •  
  • The backup proxy server you want to remove is the default backup proxy server in Veeam Backup for Microsoft 365.
    •  
 If you do not set this property to true, Veeam Backup for Microsoft 365 will not remove a backup proxy server in these conditions.


 
userName
string
Specifies the user name of the account used for authentication to the server on which the backup proxy server is installed.


 
userPassword
string <password>  (SecureString) 
Specifies a password.


 
object (RESTSshSettingsFromClient) 
Specifies credentials to access the Linux-based backup proxy server.


 
Responses 
204
No Content


default
Operation failure response.


post/v8/Proxies/{proxyId}/Remove
Request samples 
application/json
{
  • "force": true,
  • "userName": "string",
  • "userPassword": "pa$$word",
  • "sshSettings": {
    }
}
Response samples 
application/json
{
  • "message": "string",
  • "errorCode": "ProxyOffline",
  • "stackTrace": "string"
}
Rescan Backup Proxy Servers
Rescans backup proxy servers.


x-codegen-request-body-name:  rescanOptions
SecurityBearer 
Request 
Request Body schema: application/json
required
Array of objects (RESTItemGuidId) 
Specifies IDs of the backup proxy servers that you want to rescan. For more information on how to get such IDs, see Get Backup Proxy Servers.


 
Responses 
204
No Content


default
Operation failure response.


post/v8/Proxies/Rescan
Request samples 
application/json
{
  • "proxies": [
    ]
}
Response samples 
application/json
{
  • "message": "string",
  • "errorCode": "ProxyOffline",
  • "stackTrace": "string"
}
Check SSH Connection
Allows you to check the SSH connection to a Linux machine.


x-codegen-request-body-name:  sshConfig
SecurityBearer 
Request 
query Parameters
host
required
string
Specifies the full DNS name or IP address of a Linux machine.


 
Request Body schema: application/json
required
account
string
Specifies a name of the SSH user account.


 
accountPassword
string <password>  (SecureString) 
Specifies a password.


 
port
integer or null <int32> 
Specifies a port number which is used to connect to the specified backup proxy server through SSH. The default value is 22.


 
connectionTimeout
integer or null <int32> 
Specifies the SSH connection timeout in milliseconds. This timeout is used to wait for connection to the specified backup proxy server through SSH. The default value is 30000.


 
privateKeyBase64
string or null
Specifies the content of the private key file provided as a Base64 string.


 
privateKeyPassphrase
string <password>  (SecureString) 
Specifies a password.


 
elevateAccountToRoot
boolean or null
Defines whether the SSH user account privileges will be elevated in case of insufficient privileges.


 
addToSudoers
boolean or null
Defines whether the SSH user account will be added to the Sudoers group.


 
UseSuIfSudoUnavailable
boolean or null
Defines whether it is allowed to use SU if sudo is unavailable.


 
rootPassword
string <password>  (SecureString) 
Specifies a password.


 
fingerprint
string or null
Specifies the SSH fingerprint.


 
publicBase64Key
string or null
Specifies the content of the public key file provided as a Base64 string.


Note: This property is required to verify connection.


 
ignoreFingerprintCheck
boolean or null
Defines whether to skip verification of the SSH fingerprint.


 
Responses 
200
OK


default
Operation failure response.


post/v8/Proxies/CheckSshConnectionConfig
Request samples 
application/json
{
  • "account": "string",
  • "accountPassword": "pa$$word",
  • "port": 0,
  • "connectionTimeout": 0,
  • "privateKeyBase64": "string",
  • "privateKeyPassphrase": "pa$$word",
  • "elevateAccountToRoot": true,
  • "addToSudoers": true,
  • "UseSuIfSudoUnavailable": true,
  • "rootPassword": "pa$$word",
  • "fingerprint": "string",
  • "publicBase64Key": "string",
  • "ignoreFingerprintCheck": true
}
Response samples 
application/json
{
  • "status": "Success",
  • "fingerprint": "string",
  • "publicBase64Key": "string"
}

    
    

                                

                                    
Document updated 12/18/2025
Page content applies to build 8.3.0.2201