Veeam Backup for Microsoft Azure 8.1
REST API Reference
Related documents

SLA Details

The /policy/slaBased resource collection represents SLA compliance results of each SLA-based backup policy.

Get SLA Results per Period

The HTTP GET request to the /policy/slaBased/slaTimeSeries/{policyId} endpoint retrieves information on each available calculated period (day, week or month) of a specific schedule type configured the SLA-based backup policy with the specified ID.

SecurityBearer
Request
path Parameters
policyId
required
string <uuid>

Specifies a system ID assigned to an SLA-based backup policy in the Veeam Backup for Microsoft Azure REST API.

query Parameters
SlaFilterSessionStatus
string (SlaFilterSessionStatus)

Returns information on periods that have the specified SLA compliance status only.

Enum: "Success" "Failure" "All"
ScheduleType
string (ScheduleType)

Returns information on the specified schedule type only.

Enum: "Snapshot" "Backup" "Archive"
Responses
200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

get/api/v8.1/policy/slaBased/slaTimeSeries/{policyId}
Request samples 
Response samples 
application/json
[
  • {
    }
]
Get SLA Compliance per VM
The HTTP GET request to the /policy/slaBased/slaInstances/{policyId}} endpoint retrieves SLA compliance information on each Azure VM protected by the SLA-based backup policy with the specified ID.


SecurityBearer 
Request 
path Parameters
policyId
required
string <uuid> 
Specifies a system ID assigned to the SLA-based backup policy in the Veeam Backup for Microsoft Azure REST API.


 
query Parameters
SlaComplianceStatusFilter
required
string (SlaComplianceStatusFilter) 
Returns information on VMs with the specified SLA compliance status only.


 Enum: "All" "MetSla" "MissedSla" "Removed"  
dateFrom
required
string <date> 
Returns information only for the period that started after the specified date and time. Note: The parameter value must be specified in the UTC time zone in the following format: YYYY-MM-DDTHH:MM:SSZ.


 
dateTo
required
string <date> 
Returns information only for the period that ended before the specified date and time. Note: The parameter value must be specified in the UTC time zone in the following format: YYYY-MM-DDTHH:MM:SSZ.


 
ScheduleType
required
string (ScheduleType) 
Returns information on VMs protected using the specified schedule type only.


 Enum: "Snapshot" "Backup" "Archive"  
nameSearchPattern
string
Returns information on a VM with the specified name.


 
Responses 
200
OK


400
Bad Request


401
Unauthorized


403
Forbidden


get/api/v8.1/policy/slaBased/slaInstances/{policyId}
Request samples 
Response samples 
application/json
{
  • "statistic": {
    },
  • "items": [
    ]
}
Get SLA-Based Backup Policy Sessions per VM
The HTTP GET request to the /policy/slaBased/slaSessions/{policyId}/{instanceId} endpoint retrieves information on each session performed for a specific Azure VM protected by the SLA-based backup policy with the specified ID.


SecurityBearer 
Request 
path Parameters
policyId
required
string <uuid> 
Specifies a system ID assigned to the SLA-based backup policy in the Veeam Backup for Microsoft Azure REST API.


 
instanceId
required
string
Specifies a system ID assigned to the protected VM in the Veeam Backup for Microsoft Azure REST API.


 
query Parameters
dateFrom
required
string <date> 
Returns sessions only for the period that started after the specified date and time. Note: The parameter value must be specified in the UTC time zone in the following format: YYYY-MM-DDTHH:MM:SSZ.


 
dateTo
required
string <date> 
Returns sessions only for the period that ended before the specified date and time. Note: The parameter value must be specified in the UTC time zone in the following format: YYYY-MM-DDTHH:MM:SSZ.


 
ScheduleType
string (ScheduleType) 
Returns sessions of the specified schedule type only.


 Enum: "Snapshot" "Backup" "Archive"  
Offset
integer <int32>   >= 0 
Specifies the first N items of a resource collection that will be excluded from the response.


 
Limit
integer <int32>   >= -1 
Specifies the maximum number of items of a resource collection that will be returned in the response.


 
Responses 
200
OK


400
Bad Request


401
Unauthorized


403
Forbidden


get/api/v8.1/policy/slaBased/slaSessions/{policyId}/{instanceId}
Request samples 
Response samples 
application/json
{
  • "offset": 0,
  • "limit": 0,
  • "totalCount": 0,
  • "_links": {},
  • "results": [
    ]
}
Get SLA-Based Backup Policy Session Tasks
The HTTP GET request to the /policy/slaBased/slaSessionTasks/{instanceId}/{sessionID} endpoint retrieves information on each task of the session with the specified ID.


SecurityBearer 
Request 
path Parameters
sessionID
required
string
Specifies a system ID assigned to the session in the Veeam Backup for Microsoft Azure REST API.


 
instanceId
required
string
Specifies a system ID assigned to the protected VM in the Veeam Backup for Microsoft Azure REST API.


 
Responses 
200
OK


400
Bad Request


401
Unauthorized


403
Forbidden


get/api/v8.1/policy/slaBased/slaSessionTasks/{instanceId}/{sessionID}
Request samples 
Response samples 
application/json
{
  • "items": [
    ]
}