Start Backup Policy

You can start a backup policy manually.

Request

To start a backup policy with the specified ID, send the HTTP POST request to the /policies/{policyId}/start endpoint. {policyId} is a system ID assigned to the backup policy in the Veeam Backup for Microsoft Azure REST API.

HTTP Request

POST https://<hostname>/api/v2/policies/{policyId}/start

Request Headers

The request contains the following headers.

Header

Required

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.

Response

The server returns the following response to the client.

Response Codes

A successfully completed operation returns a 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

Value

Description

Content-length

integer

Identifies the length of the response body message, in bytes.

Content-type

  • application/json
  • application/problem+json

Identifies the media type of the response body message.

Response Body

In the response body, Veeam Backup for Microsoft Azure returns the session ID of the starting the backup policy operation. For the session log details, see Get Session Log Details.

Start Backup PolicyExample

The following request starts a backup policy with the ID 87f58621-bb08-4525-a1d7-927acbe2f067.

Request:

POST https://51.11.247.127:<%PORT%>/api/v2/policies/87f58621-bb08-4525-a1d7-927acbe2f067/start

 

Request Header:

Authorization: Bearer <Access-Token>

 

Response:

202

 

Response Body:

[

 {

   "id": "87f58621-bb08-4525-a1d7-927acbe2f067",

   "type": "PolicyBackup",

   "status": "Pending",

   "usn": 0,

   "backupJobInfo": {

     "policyId": "a1c3b4cb-29d4-4615-b4d8-d1e1b7f3bf55",

     "policyName": "Backup Policy",

     "protectedInstancesCount": 0,

     "policyRemoved": false

   },

   "_links": {

     "self": {

       "href": "https://51.11.247.127/api/v2/jobSessions/87f58621-bb08-4525-a1d7-927acbe2f067"

     },

     "log": {

       "href": "https://51.11.247.127/api/v2/jobSessions/87f58621-bb08-4525-a1d7-927acbe2f067/log"

     }

   },

 },

 {

   "id": "84a62a09-3d7f-436f-9768-6e40d1c40bff",

   "type": "PolicySnapshot",

   "status": "Pending",

   "usn": 0,

   "backupJobInfo": {

     "policyId": "a1c3b4cb-29d4-4615-b4d8-d1e1b7f3bf55",

     "policyName": "Backup Policy",

     "protectedInstancesCount": 0,

     "policyRemoved": false

   },

   "_links": {

     "self": {

       "href": "https://51.11.247.127/api/v2/jobSessions/84a62a09-3d7f-436f-9768-6e40d1c40bff"

     },

     "log": {

       "href": "https://51.11.247.127/api/v2/jobSessions/84a62a09-3d7f-436f-9768-6e40d1c40bff/log"

     }

   },

 }

]

I want to report a typo

There is a misspelling right here:

 

I want to let the Veeam Documentation Team know about that.