Veeam Backup & Replication 13
REST API Reference
Related documents

Traffic Rules

The Traffic Rules section defines paths and operations for retrieving and editing information about network traffic rules that are configured on the backup server.

Get Traffic Rules

The HTTP GET request to the /api/v1/trafficRules path allows you to get network traffic rules that control traffic transferred between backup infrastructure components.

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.

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/trafficRules
Request samples 
Response samples 
application/json
{
  • "useMultipleStreamsPerJob": true,
  • "uploadStreamsCount": 5,
  • "trafficRules": [
    ],
  • "preferredNetworks": {
    }
}
Edit Traffic Rules
The HTTP PUT request to the /api/v1/trafficRules path allows you to edit network traffic rules that are configured on the backup 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
useMultipleStreamsPerJob
required
boolean
If true, Veeam Backup & Replication uses multiple TCP/IP transfer connection for every job session.


 
uploadStreamsCount
integer <integer> 
Number of TCP/IP connections per job.


 
Array of objects (TrafficRuleModel) 
Array of traffic rules.


 
object (PreferredNetworksModel) 
Preferred networks used for backup and replication traffic.


 
Responses 
201
An Infrastructure session has been created to edit the traffic rules. 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.


put/api/v1/trafficRules
Request samples 
application/json
{
  • "useMultipleStreamsPerJob": true,
  • "uploadStreamsCount": 5,
  • "trafficRules": [
    ],
  • "preferredNetworks": {
    }
}
Response samples 
application/json
{
  • "useMultipleStreamsPerJob": true,
  • "uploadStreamsCount": 5,
  • "trafficRules": [
    ],
  • "preferredNetworks": {
    }
}