Veeam Backup for Microsoft Azure 8
REST API Reference
Related documents

Overview

The /overview collection allows you to get an overview of your Veeam Backup for Microsoft Azure configuration.

Get Session Summary Report

The HTTP GET request to the /overview/sessionsSummary endpoint retrieves session statistics for the past 24 hours.

SecurityBearer
Responses
200

OK

400

Bad Request

401

Unauthorized

403

Bad Request

get/api/v8/overview/sessionsSummary
Request samples 
curl -i -X GET \
  https://123.123.123.123/api/v8/overview/sessionsSummary \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "latestSessionsErrorCount": 0,
  • "latestSessionsErrorCountDifference": "NotChanged",
  • "latestSessionsWarningCount": 0,
  • "latestSessionsWarningCountDifference": "NotChanged",
  • "latestSessionsSuccessCount": 0,
  • "latestSessionsSuccessCountDifference": "NotChanged",
  • "latestSessionsRunningCount": 0
}

Get Policy Summary Report

The HTTP GET request to the /overview/statistics endpoint retrieves statistics on the number of snapshots, backups and archived backups successfully created by backup policies during a specific time period.

SecurityBearer
Request
query Parameters
PeriodFlag
required
string (ReportPeriod)

Specifies the time period for which the statistics must be collected. The default period is the past 24 hours.

Enum: "Day" "Week" "Month" "Year" "Unknown"
Responses
200

OK

400

Bad Request

401

Unauthorized

403

Bad Request

get/api/v8/overview/statistics
Request samples 
curl -i -X GET \
  'https://123.123.123.123/api/v8/overview/statistics?PeriodFlag=Day' \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "snapshotsCount": 0,
  • "backupsCount": 0,
  • "archivesCount": 0,
  • "snapshotsTotalCount": 0,
  • "backupsTotalCount": 0,
  • "archivesTotalCount": 0
}

Get Protected Resources Report

The HTTP GET request to the /overview/protectedWorkloads endpoint retrieves statistics on the number of available Azure resources that got protected by Veeam Backup for Microsoft Azure during a specific time period.

SecurityBearer
Request
query Parameters
PeriodFlag
required
string (ReportPeriod)

Specifies the time period for which the statistics must be collected. The default period is the past 24 hours.

Enum: "Day" "Week" "Month" "Year" "Unknown"
Responses
200

OK

400

Bad Request

401

Unauthorized

403

Bad Request

get/api/v8/overview/protectedWorkloads
Request samples 
curl -i -X GET \
  'https://123.123.123.123/api/v8/overview/protectedWorkloads?PeriodFlag=Day' \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "virtualMachinesTotalCount": 0,
  • "virtualMachinesProtectedCount": 0,
  • "sqlDatabasesTotalCount": 0,
  • "sqlDatabasesProtectedCount": 0,
  • "fileSharesTotalCount": 0,
  • "fileSharesProtectedCount": 0
}

Get Storage Usage Report

The HTTP GET request to the /overview/storageUsage endpoint retrieves statistics on the amount of storage space that is currently consumed by backups and archived backups created by Veeam Backup for Microsoft Azure in blob containers, and the number of snapshots created for the protected resources.

SecurityBearer
Responses
200

OK

400

Bad Request

401

Unauthorized

403

Bad Request

get/api/v8/overview/storageUsage
Request samples 
curl -i -X GET \
  https://123.123.123.123/api/v8/overview/storageUsage \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "snapshotsCount": 0,
  • "archivesCount": 0,
  • "backupCount": 0,
  • "totalUsage": 0,
  • "hotUsage": 0,
  • "coolUsage": 0,
  • "archiveUsage": 0
}

Get Policy Duration Report

The HTTP GET request to the /overview/topPoliciesDuration endpoint retrieves top N backup policies for fluctuations in execution time (including retries).

SecurityBearer
Request
query Parameters
source
string (TopPolicySource)
Default: "Snapshot"

Specifies the type of the policy session.

Enum: "Snapshot" "Backup" "Archive" "Unknown"
count
integer <int32>
Default: 10

Specifies the top N number of backup policies that will be returned in the response.

Responses
200

OK

400

Bad Request

401

Unauthorized

403

Bad Request

get/api/v8/overview/topPoliciesDuration
Request samples 
curl -i -X GET \
  'https://123.123.123.123/api/v8/overview/topPoliciesDuration?source=Snapshot&count=10' \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "data": [
    ]
}

Get Bottlenecks Report

The HTTP GET request to the /overview/bottlenecks endpoint retrieves information on possible backup bottlenecks.

SecurityBearer
Responses
200

OK

400

Bad Request

401

Unauthorized

403

Bad Request

get/api/v8/overview/bottlenecksOverview
Request samples 
curl -i -X GET \
  https://123.123.123.123/api/v8/overview/bottlenecksOverview \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "workerWaitTimeState": "Optimized",
  • "averageWorkersWaitTimeMin": "string",
  • "maximumWorkersWaitTimeMin": "string",
  • "workerBottleneckRegion": "string",
  • "cpuQuotaState": "NoIssues",
  • "cpuQuotaBottleneckRegion": "string",
  • "storageAccountBottleneckState": "NoIssues",
  • "storageAccountBottleneckRegion": "string",
  • "storageAccountBottleneckName": "string",
  • "storageAccountBottleneckResourceId": "string"
}