Export Collection of Virtual Machines

You can export a list of Azure VMs to a CSV or an XML file and download the file. To specify the required type of the file, use the Accept request header.

Request

To retrieve a representation of a collection of Azure VMs, send the HTTP POST request to the /workers/export endpoint.

HTTP Request

POST https://<hostname>/api/v2/workers/export

Query Parameters

To control the amount and order of data in the response the following query parameters:

Query Parameter

Value

Description

ExistsState

  • OnlyExists
  • OnlyDeleted
  • All

Includes only Azure VMs with the specified state. For more information, see Filter Parameters.

VmFromProtectedRegions

boolean

Defines whether an Azure VM resides in the protected region.

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.

Accept

Optional

  • text/scv
  • application/xml

Specifies a media type of representation of the exported data. The default value is text/csv media type.

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 a link to download the file with the exported list of Azure VMs.

Export Collection of Virtual MachinesExample

The following request exports a full list of Azure VMs that can be protected.

Request:

GET https://51.11.247.127/api/v2/workers/export

 

Request Header:

Authorization: Bearer <Access-Token>

Accept: text/scv

 

Response:

200

 

Response Body:

Download file

I want to report a typo

There is a misspelling right here:

 

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