Veeam Backup for Microsoft Azure 8
REST API Reference
Related documents

SLA Templates

The /policyTemplates/slaTemplate resource collection represents SLA templates added to Veeam Backup for Microsoft Azure.

Get SLA Template Data

The HTTP GET request to the /policyTemplates/slaTemplate/{templateId} endpoint retrieves information on an SLA template with the specified ID.

SecurityBearer
Request
path Parameters
templateId
required
string <uuid>

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

query Parameters
TemplateName
string or null

Returns an SLA template with the specified name.

x-veeam-parameter-group: SlaPolicyTemplateQueryOptions
Responses
200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

get/api/v8/policyTemplates/slaTemplate/{templateId}
Request samples 
curl -i -X GET \
  'https://123.123.123.123/api/v8/policyTemplates/slaTemplate/{templateId}?TemplateName=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "description": "string",
  • "lastModifiedUtc": "2019-08-24T14:15:22Z",
  • "assignedPolicies": 0,
  • "slaConfiguration": {
    },
  • "_links": {}
}

Remove SLA Template

The HTTP DELETE request to the /policyTemplates/slaTemplate/{templateId} endpoint deletes a specific SLA template from the Veeam Backup for Microsoft Azure configuration database.

SecurityBearer
Request
path Parameters
templateId
required
string <uuid>

Specifies the system ID assigned to the SLA template in the Veeam Backup for Microsoft Azure REST API.

Responses
204

No Content

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

409

Conflict

delete/api/v8/policyTemplates/slaTemplate/{templateId}
Request samples 
curl -i -X DELETE \
  'https://123.123.123.123/api/v8/policyTemplates/slaTemplate/{templateId}' \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/problem+json
{
  • "detail": "string",
  • "errors": {
    },
  • "status": 0,
  • "title": "string",
  • "traceId": "string",
  • "type": "string"
}

Modify SLA Template

The HTTP PUT request to the /policyTemplates/slaTemplate/{templateId} endpoint updates settings of an SLA template with the specified ID.

SecurityBearer
Request
path Parameters
templateId
required
string <uuid>

Specifies the system ID assigned to the SLA template in the Veeam Backup for Microsoft Azure REST API.

Request Body schema: application/json
required
name
string

Specifies a new name for the SLA template.

description
string

Specifies a new description for the SLA template.

object (SlaConfiguration)

Specifies the SLA template configuration.

Responses
200

OK

204

No Content

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

415

Client Error

put/api/v8/policyTemplates/slaTemplate/{templateId}
Request samples
application/json
{
  • "name": "string",
  • "description": "string",
  • "slaConfiguration": {
    }
}
Response samples
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "description": "string",
  • "lastModifiedUtc": "2019-08-24T14:15:22Z",
  • "assignedPolicies": 0,
  • "slaConfiguration": {
    },
  • "_links": {}
}

Get Collection of SLA Templates

The HTTP GET request to the /policyTemplates/slaTemplate endpoint retrieves a list of SLA templates configured in Veeam Backup for Microsoft Azure.

SecurityBearer
Request
query Parameters
TemplateName
string or null

Returns an SLA template with the specified name.

x-veeam-parameter-group: SlaPolicyTemplateQueryOptions
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/policyTemplates/slaTemplate
Request samples 
curl -i -X GET \
  'https://123.123.123.123/api/v8/policyTemplates/slaTemplate?TemplateName=string&Offset=0&Limit=-1' \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "offset": 0,
  • "limit": 0,
  • "totalCount": 0,
  • "_links": {},
  • "results": [
    ]
}

Create SLA Template

The HTTP POST request to the /policyTemplates/slaTemplate endpoint creates a new SLA template.

SecurityBearer
Request
Request Body schema: application/json
required
name
string

Specifies the name for the SLA template.

description
string

Specifies the description of the SLA template.

object (SlaConfiguration)

Specifies the SLA template configuration.

Responses
201

Created

400

Bad Request

401

Unauthorized

403

Forbidden

415

Client Error

post/api/v8/policyTemplates/slaTemplate
Request samples
application/json
{
  • "name": "string",
  • "description": "string",
  • "slaConfiguration": {
    }
}
Response samples
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "description": "string",
  • "lastModifiedUtc": "2019-08-24T14:15:22Z",
  • "assignedPolicies": 0,
  • "slaConfiguration": {
    },
  • "_links": {}
}

Get Policies That Have SLA Template Assigned

The HTTP GET request to the /policyTemplates/slaTemplate/{templateId}/assignedProtectionPolicies endpoint retrieves a list of SLA-based backup policies that have the specified SLA template assigned.

SecurityBearer
Request
path Parameters
templateId
required
string <uuid>

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

Responses
200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

get/api/v8/policyTemplates/slaTemplate/{templateId}/assignedProtectionPolicies
Request samples 
curl -i -X GET \
  'https://123.123.123.123/api/v8/policyTemplates/slaTemplate/{templateId}/assignedProtectionPolicies' \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "offset": 0,
  • "limit": 0,
  • "totalCount": 0,
  • "_links": {},
  • "results": [
    ]
}