Get Collection of Worker Configurations

You can get a list of all worker configurations.

Request

To retrieve a representation of a collection of worker configurations, send the HTTP GET request to the /workerConfiguration endpoint.

HTTP Request

GET https://<hostname>/api/v2/workerConfiguration

Query Parameters

To control the amount and order of data in the response, you can use Offset, Limit, SearchPattern and the following query parameters:

Query Parameter

Value

Description

RegionId

string

Returns only worker configurations that reside in the region with the specified ID. For more information, see Filter Parameters.

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 a representation of the /workers collection. The WorkerV2 schema is used for the collection representation.

Get Collection of Worker ConfigurationsExample

The following request returns a full list of worker configurations added to Veeam Backup for Microsoft Azure.

Request:

GET https://51.11.247.127/api/v2/workerConfiguration

 

Request Header:

Authorization: Bearer <Access-Token>

 

Response:

200

 

Response Body:

{

 "offset": 0,

 "limit": 200,

 "totalCount": 1,

 "results": [

   {

     "resourceId": "/subscriptions/3a9a4930-7bbc-4b83-9c68-15d674fbc803/resourcegroups/cpm-backup-martin/providers/microsoft.compute/virtualmachines/vba-d0703cd7-de38-4b56-a9a8-883fdf9c4f07",

     "name": "VBA-d0703cd7-de38-4b56-a9a8-883fdf9c4f07",

     "host": "10.250.130.5",

     "network": "rnd-backup-us-west",

     "subnetName": "rnd-backup-us-west-subnet",

     "instanceType": "Standard_A1_v2",

     "status": "Idle",

     "region": "West US",

     "regionId": "westus"

   }

 ],

 "_links": {

   "self": {

     "href": "https://51.11.247.127/api/v2/workers?offset=0&limit=200"

   }

 }

}

I want to report a typo

There is a misspelling right here:

 

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