Veeam Backup for Microsoft Azure 8
REST API Reference
Related documents

Storage Templates

The /policyTemplates/storageTemplate resource collection represents storage templates added to Veeam Backup for Microsoft Azure.

Get Storage Template Data

The HTTP GET request to the /policyTemplates/storageTemplate/{templateId} endpoint retrieves information on a storage template with the specified ID.

SecurityBearer
Request
path Parameters
templateId
required
string <uuid>

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

Responses
200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

get/api/v8/policyTemplates/storageTemplate/{templateId}
Request samples 
curl -i -X GET \
  'https://123.123.123.123/api/v8/policyTemplates/storageTemplate/{templateId}' \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "description": "string",
  • "isAssigned": true,
  • "storageConfiguration": {
    },
  • "_links": {}
}

Remove Storage Template

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

SecurityBearer
Request
path Parameters
templateId
required
string <uuid>

Specifies a system ID assigned to the storage 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/storageTemplate/{templateId}
Request samples 
curl -i -X DELETE \
  'https://123.123.123.123/api/v8/policyTemplates/storageTemplate/{templateId}' \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/problem+json
{
  • "detail": "string",
  • "errors": {
    },
  • "status": 0,
  • "title": "string",
  • "traceId": "string",
  • "type": "string"
}

Modify Storage Template

The HTTP PUT request to the /policyTemplates/storageTemplate/{templateId} endpoint updates settings of a storage template with the specified ID.

SecurityBearer
Request
path Parameters
templateId
required
string <uuid>

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

Request Body schema: application/json
required
name
string [ 1 .. 255 ] characters

Specifies a name for the storage template.

description
string

Specifies a description for the storage template.

object (StorageTemplateConfigurationFromClient)

Specifies the storage 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/storageTemplate/{templateId}
Request samples
application/json
{
  • "name": "string",
  • "description": "string",
  • "storageConfiguration": {
    }
}
Response samples
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "description": "string",
  • "isAssigned": true,
  • "storageConfiguration": {
    },
  • "_links": {}
}

Get Collection of Storage Templates

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

SecurityBearer
Request
query Parameters
Name
string or null

Returns a storage template with the specified name.

x-veeam-parameter-group: StoragePolicyTemplateQueryOptions
RepositoryId
string or null <uuid>

Returns only storage templates that use a repository with the specified ID.

x-veeam-parameter-group: StoragePolicyTemplateQueryOptions
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/storageTemplate
Request samples 
curl -i -X GET \
  'https://123.123.123.123/api/v8/policyTemplates/storageTemplate?Name=string&RepositoryId=497f6eca-6276-4993-bfeb-53cbbbba6f08&Offset=0&Limit=-1' \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "offset": 0,
  • "limit": 0,
  • "totalCount": 0,
  • "_links": {},
  • "results": [
    ]
}

Create Storage Template

The HTTP POST request to the /policyTemplates/storageTemplate endpoint creates a new storage template.

SecurityBearer
Request
Request Body schema: application/json
required
name
string [ 1 .. 255 ] characters

Specifies a name for the storage template.

description
string

Specifies a description for the storage template.

object (StorageTemplateConfigurationFromClient)

Specifies the storage template configuration.

Responses
201

Created

400

Bad Request

401

Unauthorized

403

Forbidden

415

Client Error

post/api/v8/policyTemplates/storageTemplate
Request samples
application/json
{
  • "name": "string",
  • "description": "string",
  • "storageConfiguration": {
    }
}
Response samples
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "description": "string",
  • "isAssigned": true,
  • "storageConfiguration": {
    },
  • "_links": {}
}

Get Policies That Have Storage Template Assigned

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

SecurityBearer
Request
path Parameters
templateId
required
string <uuid>

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

Responses
200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

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