Veeam Backup for AWS 10
REST API Reference
Related documents

Storage Templates

The /policyTemplates/storageTemplate resource collection represents storage templates added to Veeam Backup for AWS configuration database.

Get Collection of Storage Templates

The HTTP GET request to the /policyTemplates/storageTemplate endpoint retrieves a list of storage templates added to the Veeam Backup for AWS configuration database.

SecurityBearer
Request
query Parameters
SearchPattern
string

Returns only those items of a resource collection whose names match the specified search pattern in the parameter value.

RepositoryId
string <uuid>

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

Offset
integer <int32>

Excludes from a response the first N items of a resource collection.

Limit
integer <int32>

Specifies the maximum number of items of a resource collection to return in a response.

header Parameters
x-api-version
required
string
Default: 1.8-rev0

Specifies the current version and revision of the Veeam Backup for AWS REST API.

Responses
200

Success

400

Bad Request. The request body is malformed, incomplete or otherwise invalid

401

Unauthorized. The authorization header has been expected but not found (or found but is expired).

403

Forbidden. The user sending a request does not have adequate privileges to access one or more objects specified in the request.

500

Internal Server Error. The request has been received but could not be completed because of an internal error at the server side.

503

Service Unavailable

504

Gateway Timeout

get/api/v1/policyTemplates/storageTemplates
Request samples 
Response samples 
application/json
{
  • "totalCount": 0,
  • "results": [
    ]
}
Create Storage Template
The HTTP POST request to the /policyTemplates/storageTemplate endpoint creates a new storage template.


SecurityBearer 
Request 
header Parameters
x-api-version
required
string
 Default:  1.8-rev0
Specifies the current version and revision of the Veeam Backup for AWS REST API.


 
Request Body schema: application/json
required
name
required
string
Specifies a name for the storage template.


 
description
string
Specifies a description for the storage template.


 
object (StorageConfigurationSpec) 
 
Responses 
200
Success


400
Bad Request. The request body is malformed, incomplete or otherwise invalid


401
Unauthorized. The authorization header has been expected but not found (or found but is expired).


403
Forbidden. The user sending a request does not have adequate privileges to access one or more objects specified in the request.


500
Internal Server Error. The request has been received but could not be completed because of an internal error at the server side.


503
Service Unavailable


504
Gateway Timeout


post/api/v1/policyTemplates/storageTemplates
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": {
    }
}
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 AWS REST API.


 
header Parameters
x-api-version
required
string
 Default:  1.8-rev0
Specifies the current version and revision of the Veeam Backup for AWS REST API.


 
Responses 
200
Success


400
Bad Request. The request body is malformed, incomplete or otherwise invalid


401
Unauthorized. The authorization header has been expected but not found (or found but is expired).


403
Forbidden. The user sending a request does not have adequate privileges to access one or more objects specified in the request.


404
Not Found. One or more resources specified in the request could not be found in the specified resource collection.


500
Internal Server Error. The request has been received but could not be completed because of an internal error at the server side.


503
Service Unavailable


504
Gateway Timeout


get/api/v1/policyTemplates/storageTemplates/{templateId}
Request samples 
Response samples 
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "description": "string",
  • "isAssigned": true,
  • "storageConfiguration": {
    }
}
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 AWS REST API.


 
header Parameters
x-api-version
required
string
 Default:  1.8-rev0
Specifies the current version and revision of the Veeam Backup for AWS REST API.


 
Request Body schema: application/json
required
name
required
string
Specifies a name for the storage template.


 
description
string
Specifies a description for the storage template.


 
object (StorageConfigurationSpec) 
 
Responses 
200
Success


400
Bad Request. The request body is malformed, incomplete or otherwise invalid


401
Unauthorized. The authorization header has been expected but not found (or found but is expired).


403
Forbidden. The user sending a request does not have adequate privileges to access one or more objects specified in the request.


404
Not Found. One or more resources specified in the request could not be found in the specified resource collection.


500
Internal Server Error. The request has been received but could not be completed because of an internal error at the server side.


503
Service Unavailable


504
Gateway Timeout


put/api/v1/policyTemplates/storageTemplates/{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": {
    }
}
Remove Storage Template
The HTTP DELETE request to the /policyTemplates/storageTemplate/{templateId} endpoint remove a specific storage template from the Veeam Backup for AWS configuration database.


SecurityBearer 
Request 
path Parameters
templateId
required
string <uuid> 
Specifies a system ID assigned to the storage template in the Veeam Backup for AWS REST API.


 
header Parameters
x-api-version
required
string
 Default:  1.8-rev0
Specifies the current version and revision of the Veeam Backup for AWS REST API.


 
Responses 
204
Deleted


400
Bad Request. The request body is malformed, incomplete or otherwise invalid


401
Unauthorized. The authorization header has been expected but not found (or found but is expired).


403
Forbidden. The user sending a request does not have adequate privileges to access one or more objects specified in the request.


404
Not Found. One or more resources specified in the request could not be found in the specified resource collection.


500
Internal Server Error. The request has been received but could not be completed because of an internal error at the server side.


503
Service Unavailable


504
Gateway Timeout


delete/api/v1/policyTemplates/storageTemplates/{templateId}
Request samples 
Response samples 
application/json
{
  • "type": "http://example.com",
  • "title": "string",
  • "status": 400,
  • "errorCode": "AccessDenied",
  • "details": "string",
  • "instance": "http://example.com",
  • "data": {
    }
}
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 AWS REST API.


 
header Parameters
x-api-version
required
string
 Default:  1.8-rev0
Specifies the current version and revision of the Veeam Backup for AWS REST API.


 
Responses 
200
Success


400
Bad Request. The request body is malformed, incomplete or otherwise invalid


401
Unauthorized. The authorization header has been expected but not found (or found but is expired).


403
Forbidden. The user sending a request does not have adequate privileges to access one or more objects specified in the request.


404
Not Found. One or more resources specified in the request could not be found in the specified resource collection.


500
Internal Server Error. The request has been received but could not be completed because of an internal error at the server side.


503
Service Unavailable


504
Gateway Timeout


get/api/v1/policyTemplates/storageTemplates/{templateId}/assignedPolicies
Request samples 
Response samples 
application/json
{
  • "totalCount": 0,
  • "results": [
    ]
}