Get Worker Instances Statistics

You can statistics of the worker instances added to Veeam Backup for Microsoft Azure configuration database.

Request

To retrieve a representation of worker instances, send the HTTP GET request to the /workers/statistics endpoint.

HTTP Request

GET https://<hostname>/api/v2/workers/statistics

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 statistics of all workers added  to Veeam Backup for Microsoft Azure configuration database.

Get Worker Instances StatisticsExample

The following request returns statistics of all worker instances.

Request:

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

 

Request Header:

Authorization: Bearer <Access-Token>

 

Response:

200

 

Response Body:

  {

 "countOfWorkers": 1,

 "runningWorkers": 1,

 "totalCycleTime": "1.00:00:00",

 "usedWorkers": 1,

 "deployedWorkers": 1

}

I want to report a typo

There is a misspelling right here:

 

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