Help Center
Choose product document...
Veeam Availability Console 2.0 Update 1
RESTful API Reference

Activate Agent

You can activate Veeam backup agent on a computer with the specified ID. If a computer has no Veeam backup agent installed, the request will initiate agent deployment first.


To deploy and activate backup agent on a discovered computer, send the POST HTTPS request to the URL of the /Computers /{ID}/action resource.

HTTPS Request

POST https://<Availability-Console>:1281/v2/Computers/{ID}/action

Request Headers

The request header must contain the authorization token for the current logon session.

Request Body

In the request body, the client must send the activate action property with the null value:

{"activate": null}


The server returns the following response to the client.

Response Code

A successfully completed operation returns response code 200 Success.

Response Headers

The response to this request contains the following headers. The response may also include additional standard HTTP headers.




The length of the response body.


The media type and syntax of the request body message: application/json; charset=utf-8

Response Body

In the response body, Veeam Availability Console returns a status and a message for an action.

Example Activate Agent

The following request activates agent on a discovered computer with ID 4d831142-aa0c-d333-a825-999cdda6014c.


POST https://localhost:1281/v2/Computers /4d831142-aa0c-d333-a825-999cdda6014c/action


Request Header:

Content-Type: application/json

Authorization: Bearer <Access-Token>


Request Body:

{"activate": null}


Response Code:

200 Success


Response Body:

"Management agent deployment. Task ID: 6a30a735-2152-42cd-a07e-ba4c124a7658"

Veeam Large Logo

Deployment Guide

Administrator Guide for Service Providers

User Guide for Service Providers

Quick Start Guide for Service Providers

Administrator Guide for Enterprises

User Guide for Enterprises

Quick Start Guide for Enterprises

RESTful API Reference