This is an archive version of the document. To get the most up-to-date information, see the current version.Modify Organization Automatic Deployment Settings
You can modify Veeam backup agent automatic deployment settings configured for an organization with the specified UID.
Required Privileges
To perform this task, a user must have the Portal Administrator role assigned.
Request
To modify Veeam backup agent automatic deployment settings configured for an organization, send the PATCH HTTP request to the URL of the /organizations/{organizationUid}/configuration/autodeployment resource.
HTTP Request
PATCH https://<hostname>:1280/api/v3/organizations/{organizationUid}/configuration/autodeployment |
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 |
|---|---|---|---|---|---|
organizationUid | Path | String (uuid) | Yes | — | Organization UID |
Body | Body | Array (JSON Patch) | Yes | — | Array of JSON Patch operations according to RFC 6902 |
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 modified resource representation based on the AutoDeploymentSettings schema.
Example 
The following request modifies Veeam backup agent automatic deployment settings configured for an organization with UID debcdb55-afbd-4772-bf99-5ea6a3249f43.
Request: PATCH https://localhost:1280/api/v3/organizations/debcdb55-afbd-4772-bf99-5ea6a3249f43/configuration/autodeployment
Request Header: Content-type: application/json Authorization: Bearer <Access-Token>
Request Body: [ { "op": "replace", "value": "e0f546c6-3311-4578-92a0-c5c34dfb8ac0", "path": "/backupPolicyUid" } ]
Response Code: 200 OK Response Body: { "data": { "organizationUid": "debcdb55-afbd-4772-bf99-5ea6a3249f43", "isEnabled": false, "backupPolicyUid": null, "isRetryEnabled": false, "retryCount": 3, "retryInterval": 7, "acceptNewConnections": true, "installDriver": false, "setReadOnlyAccess": true, "backupAgentSettings": { "backupAgentUid": "00000000-0000-0000-0000-000000000000", "disableScheduledBackups": false, "disableControlPanelNotification": false, "disableBackupOverMeteredConnection": false, "disableScheduleWakeup": false, "throttleBackupActivity": false, "restrictVpnConnections": false, "limitBandwidthConsumption": false, "bandwidthSpeedLimit": 1, "bandwidthSpeedLimitUnit": "mbitPerSec", "flrWithoutAdminPrivilegesAllowed": false } } } |