PUT Method

The PUT HTTP method is used to replace a resource with a similar resource that includes a different set of values.

New values must be provided in the request body. The following example replaces a resource that contains settings of a specific Veeam Agent for Microsoft Windows:

Request:

PUT https://localhost:1280/api/v3/infrastructure/backupAgents/windows/2a2db960-5e69-4316-a922-beb5eea409d0/settings

 

Request Header:

Content-Type: application/json

Authorization: Bearer <Access-Token>

 

Request Body:

{

  "disableScheduledBackups": true,

  "disableControlPanelNotification": true,

  "disableBackupOverMeteredConnection": true,

  "disableScheduleWakeup": true,

  "throttleBackupActivity": true,

  "restrictVpnConnections": true,

  "limitBandwidthConsumption": false,

  "bandwidthSpeedLimit": 0,

  "bandwidthSpeedLimitUnit": "MbitPerSec",

  "flrWithoutAdminPrivilegesAllowed": true

}

In some cases to replace a resource you must upload a file. The following example installs a new Veeam Backup & Replication server license.

Request:

PUT https://localhost:1280/api/v3/licensing/backupServer/41b07607-493c-428f-8b29-a2291900b0a8

 

Request Header:

Content-Type: multipart/form-data

Authorization: Bearer <Access-Token>

 

Request Body:

--Random

Content-Disposition: form-data; name="file"; filename="C:/Users/Administrator/Downloads/veeam_license.lic"

--Random--

In case of success, the PUT HTTP method returns the 200 OK response code.

I want to report a typo

There is a misspelling right here:

 

I want to let the Veeam Documentation Team know about that.