This is an archive version of the document. To get the most up-to-date information, see the current version.Replace Veeam Agent for Microsoft Windows Settings
You can replace settings configured for a Veeam Agent for Microsoft Windows with the specified UID.
Required Privileges
To perform this task, a user must have one of the following roles assigned: Portal Administrator, Service Provider Global Administrator, Service Provider Administrator, Company Owner, Company Administrator.
Request
To replace settings configured for a Veeam Agent for Microsoft Windows, send the PUT HTTP request to the URL of the /infrastructure/backupAgents/windows/{backupAgentUid}/settings resource.
HTTP Request
PUT https://<hostname>:1280/api/v3/infrastructure/backupAgents/windows/{backupAgentUid}/settings |
Request Headers
The request contains the following headers.
Header | Required/Optional | Value | Description |
Authorization | Required | Bearer <Access-Token> | Authenticates a client who sends the request to the server. Must contain the access token for the current logon session in the Bearer <Access-Token> format. |
Content-Type | Required | application/json | Identifies a media type that is used in the body of the request. |
Accept | Optional | application/json | Specifies a media type of representation that is required in the response message. If the requested type is not supported, the server will return the response in the application/json media type. |
Request parameters
A list of parameters that are applicable for this operation:
Name | In | Type | Required | Default | Description |
|---|---|---|---|---|---|
backupAgentUid | Path | String (uuid) | Yes | — | Veeam backup agent UID |
Body | Body | Yes | — | Properties of Veeam backup agent settings |
Response
The server returns the following response to the client.
Response Code
A successfully completed operation returns response code 200 OK.
Response Headers
The response to this request contains the following headers. The response may also include additional standard HTTP headers.
Header | Description |
Content-length | The length of the response body. |
Content-type | The media type and syntax of the request body message: application/json; charset=utf-8 |
Response Body
In the response body, Veeam Service Provider Console returns a resource representation of new settings based on the BackupAgentSettings schema.
Example 
The following request replaces settings configured for a Veeam backup agent with UID d8f3e79b-4bc3-4ab7-8543-2bebf09657e2.
Request: PUT https://localhost:1280/api/v3/infrastructure/backupAgents/d8f3e79b-4bc3-4ab7-8543-2bebf09657e2/settings
Request Header: Content-Type: application/json Authorization: Bearer <Access-Token>
Request Body: { "disableScheduledBackups": false, "disableControlPanelNotification": false, "disableBackupOverMeteredConnection": false, "disableScheduleWakeup": true, "throttleBackupActivity": false, "restrictVpnConnections": false, "limitBandwidthConsumption": false, "bandwidthSpeedLimit": 1, "bandwidthSpeedLimitUnit": "mbytePerSec", "flrWithoutAdminPrivilegesAllowed": false }
Response Code: 200 Success
Response Body: { "data": { "backupAgentUid": "03473b42-89fb-7227-9c6a-95e6908f25de", "disableScheduledBackups": false, "disableControlPanelNotification": false, "disableBackupOverMeteredConnection": false, "disableScheduleWakeup": true, "throttleBackupActivity": false, "restrictVpnConnections": false, "limitBandwidthConsumption": false, "bandwidthSpeedLimit": 1, "bandwidthSpeedLimitUnit": "mbytePerSec", "flrWithoutAdminPrivilegesAllowed": false } } |