Help Center
Choose product document...
Veeam Availability Console 3.0
RESTful API Reference

Assign Backup Policy

You can assign a backup policy to a Veeam backup agent with the specified ID.


To assign a backup policy, send the POST HTTPS request to the URL of its resource. In URL query, you must provide backup policy system ID and specify whether license escalation is allowed. The default value for allowLicenseEscalate parameter is false.

HTTPS Request

POST https://<Availability-Console>:1281/v2/backupAgents/{ID}/assignPolicy?backupPolicyId={ID}&allowLicenseEscalate=true

Request Headers

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


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 message for an action.

Example Assign Backup Policy

The following example assigns backup policy with ID 3 to Veeam backup agent with ID cc52bf30-a1b0-41dd-8b24-553dab48b43f.


POST https://<Availability-Console>:1281/v2/backupAgents/cc52bf30-a1b0-41dd-8b24-553dab48b43f/assignPolicy?backupPolicyId=3&allowLicenseEscalate=true


Request Header:

Content-Type: application/json

Authorization: Bearer <Access-Token>


Response Code:

200 Success


Response Body:

"Backup policy has been assigned."

Veeam Large Logo

Deployment Guide

Guide for Service Providers

Guide for End Users

Guide for Resellers

Usage Scenarios for Service Providers

RESTful API Reference