This is an archive version of the document. To get the most up-to-date information, see the current version.Install Backup Agent on Discovered Computer
You can deploy Veeam backup agent and management agent on a discovered computer with the specified UID. Operation deploys only the missing component if the other one is already installed.
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 deploy Veeam backup agent and management agent on a discovered computer, send the POST HTTP request to the URL of the /discovery/computers/{computerUid}/installBackupAgent resource.
HTTP Request
POST https://<hostname>:1280/api/v3/discovery/computers/{computerUid}/installBackupAgent |
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 |
|---|---|---|---|---|---|
computerUid | Path | String (uuid) | Yes | — | Computer UID |
Body | Body | Yes | — | Deployment configuration properties |
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 deployment task UID.
Example 
The following request deploy Veeam backup agent and management agent on a discovered computer with UID 304c08c2-0d13-4e9d-b26b-0bd5add83b3b.
Request: POST https://localhost:1280/api/v3/discovery/computers/304c08c2-0d13-4e9d-b26b-0bd5add83b3b/installBackupAgent
Request Header: Content-type: application/json Authorization: Bearer <Access-Token>
Request Body: { "backupPolicyUid": "46f4784e-d9c5-4e5d-86f5-6d091b972149", "allowAutoRebootIfNeeded": true, "setReadOnlyAccess": true, "installCbtDriver": true, "credentials": { "userName": "srv03\administrator", "password": "Password1" } }
Response Code: 200 OK
Response Body: { "data": {a3dda713-3a9d-400c-9f49-2ad4a22447b3} } |