Veeam Backup for Microsoft Azure 8
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"
x-veeam-parameter-group: SlaTimeSeriesQueryOptions
ScheduleType
string (ScheduleType)

Returns information on the specified schedule type only.

Enum: "Snapshot" "Backup" "Archive"
x-veeam-parameter-group: SlaTimeSeriesQueryOptions
Responses
200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

get/api/v8/policy/slaBased/slaTimeSeries/{policyId}
Request samples 
curl -i -X GET \
  'https://123.123.123.123/api/v8/policy/slaBased/slaTimeSeries/{policyId}?SlaFilterSessionStatus=Success&ScheduleType=Snapshot' \
  -H 'Authorization: YOUR_API_KEY_HERE'
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.

x-veeam-parameter-group: SlaInstancesQueryOptions
query Parameters
SlaComplianceStatusFilter
required
string (SlaComplianceStatusFilter)

Returns information on VMs with the specified SLA compliance status only.

Enum: "All" "MetSla" "MissedSla" "Removed"
x-veeam-parameter-group: SlaInstancesReportFilter
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.

x-veeam-parameter-group: SlaInstancesReportFilter
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.

x-veeam-parameter-group: SlaInstancesReportFilter
ScheduleType
required
string (ScheduleType)

Returns information on VMs protected using the specified schedule type only.

Enum: "Snapshot" "Backup" "Archive"
x-veeam-parameter-group: SlaInstancesReportFilter
nameSearchPattern
string

Returns information on a VM with the specified name.

x-veeam-parameter-group: SlaInstancesReportFilter
Responses
200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

get/api/v8/policy/slaBased/slaInstances/{policyId}
Request samples 
curl -i -X GET \
  'https://123.123.123.123/api/v8/policy/slaBased/slaInstances/{policyId}?SlaComplianceStatusFilter=All&dateFrom=2019-08-24&dateTo=2019-08-24&ScheduleType=Snapshot&nameSearchPattern=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'
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.

x-veeam-parameter-group: SlaSessionsQueryOptions
instanceId
required
string

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

x-veeam-parameter-group: SlaSessionsQueryOptions
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.

x-veeam-parameter-group: SlaSessionsReportFilter
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.

x-veeam-parameter-group: SlaSessionsReportFilter
ScheduleType
string (ScheduleType)

Returns sessions of the specified schedule type only.

Enum: "Snapshot" "Backup" "Archive"
x-veeam-parameter-group: SlaSessionsReportFilter
Offset
integer <int32> >= 0

Specifies the first N items of a resource collection that will be excluded from the response.

x-veeam-parameter-group: Veeam.Azure.REST.RequestQuery.V2.PageProperties
Limit
integer <int32> >= -1

Specifies the maximum number of items of a resource collection that will be returned in the response.

x-veeam-parameter-group: Veeam.Azure.REST.RequestQuery.V2.PageProperties
Responses
200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

get/api/v8/policy/slaBased/slaSessions/{policyId}/{instanceId}
Request samples 
curl -i -X GET \
  'https://123.123.123.123/api/v8/policy/slaBased/slaSessions/{policyId}/{instanceId}?dateFrom=2019-08-24&dateTo=2019-08-24&ScheduleType=Snapshot&Offset=0&Limit=-1' \
  -H 'Authorization: YOUR_API_KEY_HERE'
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.

x-veeam-parameter-group: SlaSessionTasksQueryOptions
instanceId
required
string

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

x-veeam-parameter-group: SlaSessionTasksQueryOptions
Responses
200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

get/api/v8/policy/slaBased/slaSessionTasks/{instanceId}/{sessionID}
Request samples 
curl -i -X GET \
  'https://123.123.123.123/api/v8/policy/slaBased/slaSessionTasks/{instanceId}/{sessionID}' \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "items": [
    ]
}