Veeam Backup for Microsoft 365 8
REST API Reference
Related documents

Backup Proxy Pools

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

Get Backup Proxy Pools

Returns a collection of backup proxy pools.

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/ProxyPools
Request samples 
Response samples 
application/json
{
  • "offset": 0,
  • "limit": 0,
  • "setId": "83e19bc1-5428-42b5-88ea-b28354e481f3",
  • "results": [
    ],
  • "_links": {
    }
}
Add Backup Proxy Pool
Adds a backup proxy pool to the Veeam Backup for Microsoft 365 infrastructure.


x-codegen-request-body-name:  pool
SecurityBearer 
Request 
Request Body schema: application/json
required
name
required
string
Specifies the backup proxy pool name.


 
description
required
string
Specifies the backup proxy pool description.


 
required
Array of objects (RESTProxyIdFromClient) 
Specifies IDs of the backup proxy servers to add to the new backup proxy pool. For more information on how to get such IDs, see Get Backup Proxy Servers.


 
Responses 
201
Created


default
Operation failure response.


post/v8/ProxyPools
Request samples 
application/json
{
  • "name": "string",
  • "description": "string",
  • "proxyIds": [
    ]
}
Response samples 
application/json
{
  • "id": "00000000-0000-0000-0000-000000000000",
  • "name": "string",
  • "description": "string",
  • "_links": {
    }
}
Get Backup Proxy Pool
Returns a resource representation of a backup proxy pool with the specified ID.


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


 
Responses 
200
OK


default
Operation failure response.


get/v8/ProxyPools/{poolId}
Request samples 
Response samples 
application/json
{
  • "id": "00000000-0000-0000-0000-000000000000",
  • "name": "string",
  • "description": "string",
  • "_links": {
    }
}
Edit Backup Proxy Pool Settings
Modifies settings of a backup proxy pool with the specified ID.


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


 
Request Body schema: application/json
required
name
required
string
Specifies the backup proxy pool name.


 
description
required
string
Specifies the backup proxy pool description.


 
required
Array of objects (RESTProxyIdFromClient) 
Specifies IDs of the backup proxy servers to add to the new backup proxy pool. For more information on how to get such IDs, see Get Backup Proxy Servers.


 
Responses 
204
No Content


default
Operation failure response.


put/v8/ProxyPools/{poolId}
Request samples 
application/json
{
  • "name": "string",
  • "description": "string",
  • "proxyIds": [
    ]
}
Response samples 
application/json
{
  • "message": "string",
  • "errorCode": "ProxyOffline",
  • "stackTrace": "string"
}
Remove Backup Proxy Pool
Removes a backup proxy pool with the specified ID from the Veeam Backup for Microsoft 365 infrastructure.


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


 
Responses 
204
No Content


default
Operation failure response.


delete/v8/ProxyPools/{poolId}
Request samples 
Response samples 
application/json
{
  • "message": "string",
  • "errorCode": "ProxyOffline",
  • "stackTrace": "string"
}
Get Backup Proxy Servers by Backup Proxy Pool ID
Returns a collection of backup proxy servers added to a backup proxy pool with the specified ID.


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


 
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/ProxyPools/{poolId}/proxies
Request samples 
Response samples 
application/json
{
  • "offset": 0,
  • "limit": 0,
  • "setId": "83e19bc1-5428-42b5-88ea-b28354e481f3",
  • "results": [
    ],
  • "_links": {
    }
}
Add Backup Proxy Servers to Backup Proxy Pool
Adds backup proxy servers to a backup proxy pool with the specified ID.


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


 
Request Body schema: application/json
required
 Array 
proxyId
string <uuid> 
Specifies IDs of the backup proxy servers that you want to add to the backup proxy pool or remove from the backup proxy pool. For more information on how to get such IDs, see Get Backup Proxy Servers.


 
Responses 
204
No Content


default
Operation failure response.


post/v8/ProxyPools/{poolId}/proxies
Request samples 
application/json
[
  • {
    }
]
Response samples 
application/json
{
  • "message": "string",
  • "errorCode": "ProxyOffline",
  • "stackTrace": "string"
}
Remove Backup Proxy Servers from Backup Proxy Pool
Removes backup proxy servers from a backup proxy pool with the specified ID.


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


 
Request Body schema: application/json
required
 Array 
proxyId
string <uuid> 
Specifies IDs of the backup proxy servers that you want to add to the backup proxy pool or remove from the backup proxy pool. For more information on how to get such IDs, see Get Backup Proxy Servers.


 
Responses 
204
No Content


default
Operation failure response.


delete/v8/ProxyPools/{poolId}/proxies
Request samples 
application/json
[
  • {
    }
]
Response samples 
application/json
{
  • "message": "string",
  • "errorCode": "ProxyOffline",
  • "stackTrace": "string"
}

    
    

                                

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