Veeam Backup & Replication 13
REST API Reference
Related documents

Proxies

The Proxies section defines paths and operations for managing backup proxies.

NOTE
In this version, the REST API supports VMware vSphere backup proxies, Microsoft Hyper-V off-host backup proxies and general-purpose backup proxies used with Veeam Agents.

Get All Proxies

The HTTP GET request to the /api/v1/backupInfrastructure/proxies path allows you to get an array of all backup proxies that are added to the backup infrastructure.

Available to: Veeam Backup Administrator, Veeam Backup Operator, Veeam Restore Operator, Veeam Backup Viewer, Veeam Tape Operator.

SecurityBearer
Request
query Parameters
skip
integer <int32>

Number of proxies to skip.

limit
integer <int32>
Default: 200

Maximum number of proxies to return.

orderColumn
string (EProxiesFiltersOrderColumn)

Sorts proxies by one of the proxy parameters.

Enum: "Name" "Type" "Description" "HostName"
orderAsc
boolean

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

nameFilter
string

Filters proxies by the nameFilter pattern. The pattern can match any proxy parameter. To substitute one or more characters, use the asterisk (*) character at the beginning, at the end or both.

typeFilter
Array of strings (EProxyType)

Filters proxies by proxy type.

Items Enum: "ViProxy" "HvProxy" "GeneralPurposeProxy"
hostIdFilter
string <uuid>

Filters proxies by ID of the backup server.

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.

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/proxies
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "pagination": {
    }
}
Add Proxy
The HTTP POST request to the /api/v1/backupInfrastructure/proxies path allows you to add a proxy to the backup infrastructure.
 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
description
required
string
Description of the backup proxy.


 
type
required
string (EProxyType) 
Type of backup proxy.


 
required
object (ProxyServerSettingsModel) 
Server settings for the VMware backup proxy.


 
Responses 
201
An Infrastructure session has been created to add the proxy. 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.


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/proxies
Request samples 
application/json
{
  • "type": "ViProxy",
  • "name": "proxy01.tech.local",
  • "description": "Created by TECH\\sheila.d.cory",
  • "server": {
    }
}
Response samples 
application/json
{
  • "sessionType": "Infrastructure",
  • "state": "Working",
  • "id": "89fe3413-cde0-4061-925a-6d72857db45c",
  • "name": "Infrastructure Item Saving",
  • "jobId": "89fe3413-cde0-4061-925a-6d72857db45c",
  • "creationTime": "2025-07-30T13:01:27.491999+02:00",
  • "progressPercent": 0,
  • "result": {
    },
  • "usn": 331548,
  • "initiatedBy": ".\\veeam-rest-service"
}
Get Proxy
The HTTP GET request to the /api/v1/backupInfrastructure/proxies/{id} path allows you to get a backup proxy that has the specified id.
Available to: Veeam Backup Administrator, Veeam Backup Operator, Veeam Restore Operator, Veeam Backup Viewer, Veeam Tape Operator.


SecurityBearer 
Request 
path Parameters
id
required
string <uuid> 
Backup proxy ID. To get the ID, run the Get All Proxies 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/proxies/{id}
Request samples 
Response samples 
application/json
{
  • "server": {
    },
  • "trafficRules": {
    },
  • "type": "ViProxy",
  • "id": "18b661c1-d9dc-4233-90a0-7e7b10dc2d09",
  • "name": "VMware vSphere Backup Proxy",
  • "description": "Created by TECH\\sheila.d.cory"
}
Edit Proxy
The HTTP PUT request to the /api/v1/backupInfrastructure/proxies/{id} path allows you to edit a backup proxy that has the specified id.
Available to: Veeam Backup Administrator.


SecurityBearer 
Request 
path Parameters
id
required
string <uuid> 
Backup proxy ID. To get the ID, run the Get All Proxies 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> 
Backup proxy ID.


 
description
required
string
Description of the backup proxy.


 
name
required
string
Name of the backup proxy.


 
type
required
string (EProxyType) 
Type of backup proxy.


 
required
object (ProxyServerSettingsModel) 
Server settings for the VMware backup proxy.


 
Responses 
201
An Infrastructure session has been created to edit the proxy. 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/proxies/{id}
Request samples 
application/json
{
  • "server": {
    },
  • "trafficRules": {
    },
  • "type": "ViProxy",
  • "id": "18b661c1-d9dc-4233-90a0-7e7b10dc2d09",
  • "name": "VMware vSphere Backup Proxy",
  • "description": "Created by TECH\\sheila.d.cory"
}
Response samples 
application/json
{
  • "sessionType": "Infrastructure",
  • "state": "Working",
  • "id": "89fe3413-cde0-4061-925a-6d72857db45c",
  • "name": "Infrastructure Item Saving",
  • "jobId": "89fe3413-cde0-4061-925a-6d72857db45c",
  • "creationTime": "2025-07-30T13:01:27.491999+02:00",
  • "progressPercent": 0,
  • "result": {
    },
  • "usn": 331548,
  • "initiatedBy": ".\\veeam-rest-service"
}
Remove Proxy
The HTTP DELETE request to the /api/v1/backupInfrastructure/proxies/{id} path allows you to remove a backup proxy that has the specified id from the backup infrastructure.
Available to: Veeam Backup Administrator.


SecurityBearer 
Request 
path Parameters
id
required
string <uuid> 
Backup proxy ID. To get the ID, run the Get All Proxies 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 
204
Removed.


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.


delete/api/v1/backupInfrastructure/proxies/{id}
Request samples 
Response samples 
application/json
{ }
Enable Proxy
The HTTP POST request to the /api/v1/backupInfrastructure/proxies/{id}/enable path allows you to enable a backup proxy that has the specified id.
Available to: Veeam Backup Administrator.


SecurityBearer 
Request 
path Parameters
id
required
string <uuid> 
Backup proxy ID. To get the ID, run the Get All Proxies 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 
204
Proxy has been enabled.


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.


post/api/v1/backupInfrastructure/proxies/{id}/enable
Request samples 
Response samples 
application/json
{
  • "errorCode": "AccessDenied",
  • "message": "string",
  • "resourceId": "string"
}
Disable Proxy
The HTTP POST request to the /api/v1/backupInfrastructure/proxies/{id}/disable path allows you to disable a backup proxy that has the specified id.
Available to: Veeam Backup Administrator.


SecurityBearer 
Request 
path Parameters
id
required
string <uuid> 
Backup proxy ID. To get the ID, run the Get All Proxies 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 
204
Proxy has been disabled.


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.


post/api/v1/backupInfrastructure/proxies/{id}/disable
Request samples 
Response samples 
application/json
{
  • "errorCode": "AccessDenied",
  • "message": "string",
  • "resourceId": "string"
}
Get All Proxy States
The HTTP GET request to the /api/v1/backupInfrastructure/proxies/states path allows you to get an array of proxy states.
Available to: Veeam Backup Administrator, Veeam Backup Operator, Veeam Restore Operator, Veeam Backup Viewer, Veeam Tape Operator.


SecurityBearer 
Request 
query Parameters
skip
integer <int32> 
Number of proxies to skip.


 
limit
integer <int32> 
 Default:  200
Maximum number of proxies to return.


 
orderColumn
string (EProxiesFiltersOrderColumn) 
Sorts proxies by one of the proxy parameters.


 Enum: "Name" "Type" "Description" "HostName"  
orderAsc
boolean
If true, sorts proxies in the ascending order by the orderColumn parameter.


 
nameFilter
string
Filters proxies by the nameFilter pattern. The pattern can match any proxy parameter. To substitute one or more characters, use the asterisk (*) character at the beginning, at the end or both.


 
typeFilter
Array of strings (EProxyType) 
Filters proxies by proxy type.


Items Enum: "ViProxy" "HvProxy" "GeneralPurposeProxy"  
hostIdFilter
string <uuid> 
Filters proxies by ID of the backup server.


 
isDisabledFilter
boolean
If true, Veeam Backup & Replication returns only disabled proxies.


 
isOnlineFilter
boolean
If true, Veeam Backup & Replication returns only available proxies.


 
isOutOfDateFilter
boolean
If true, Veeam Backup & Replication returns only proxies with outdated components.


 
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.


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/proxies/states
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "pagination": {
    }
}