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

Update a Veeam backup agent Job

You can update backup policy of a Veeam backup agent job with the specified system ID.

Request

To update backup policy of a job, send the POST HTTPS request to the URL of the /backupAgents/{id}/jobs/{id}/update resource. In URL query you can specify whether license escalation is allowed. The default value for allowLicenseEscalate parameter is false.

HTTP Request

POST https://<Availability-Console>:1281/v2/backupAgents/{id}/jobs/{id}/update?allowLicenseEscalate=true

Request Headers

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

Response

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.

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 Availability Console returns a message for an action.

Example Update a Veeam backup agent Job

The following example returns a response on a update action for a backup job.

Request:

POST https://localhost:1281/v2/backupAgents/cc52ec30-a1b0-41dd-8b24-553dab48b43f/jobs/4610eb17-b41c-4cc5-81d1-938ee6d89b7a/update

 

Request Header:

Content-Type: application/json

Authorization: Bearer <Access-Token>

 

Response Code:

200 Success

 

Response Body:

"Backup job has been updated."

Veeam Large Logo

Deployment Guide

Guide for Service Providers

Guide for End Users

Guide for Resellers

Usage Scenarios for Service Providers

RESTful API Reference