Veeam Backup for AWS 10
REST API Reference
Related documents

EC2 SLA-Based Backup Policies

The /policy/ec2SlaBasedPolicies resource collection represents EC2 SLA-based backup policies created in Veeam Backup for AWS.

Get Collection of SLA-Based Backup Policies

The HTTP GET request to the /api/v1/policy/ec2SlaBasedPolicies endpoint retrieves a list of SLA-based backup policies created in Veeam Backup for AWS.

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.

VirtualMachineId
string <uuid>

Returns only backup policies that protect an EC2 instance with the specified ID.

Offset
integer <int32>

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

Limit
integer <int32>

Specifies the maximum number of items of a resource collection that will be returned in the 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.

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/policy/ec2SlaBasedPolicies
Request samples 
Response samples 
application/json
{
  • "offset": 0,
  • "limit": -1,
  • "totalCount": 0,
  • "results": [
    ]
}
Create SLA-Based Backup Policy
The HTTP POST request to the /api/v1/policy/ec2SlaBasedPolicies endpoint creates a new SLA-based backup policy.


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
regionIds
required
Array of strings <uuid>   non-empty  unique 
Specifies the system IDs assigned in the Veeam Backup for AWS REST API to AWS Regions where the backed-up instances reside.


 
name
required
string  [ 1 .. 255 ] characters 
Specifies a name of the SLA-based backup policy.


 
identityId
required
string <uuid> 
Specifies the system ID assigned in the Veeam Backup for AWS REST API to an AWS Organization or an IAM role that belongs to a standalone AWS account.


 
backupType
required
string (PolicySelectionTypes) 
Specifies the type of the backup policy.


 Enum: "AllItems" "SelectedItems"  
slaTemplateId
required
string <uuid> 
Specifies the system ID assigned in the Veeam Backup for AWS REST API to the SLA template assigned to the policy.


 
description
string
Specifies a description of the SLA-based backup policy.


 
object (Ec2PolicyIncludedBackupItems) 
AWS resources that are protected by the backup policy.


 
object (Ec2PolicyExcludedBackupItems) 
Specifies AWS resources that must be excluded from the backup policy.


 
storageTemplateId
string <uuid> 
Specifies the system ID assigned in the Veeam Backup for AWS REST API to the storage template assigned to the policy.


 
object (Ec2PolicySnapshotSettings) 
Specifies cloud-native snapshot settings for the EC2 backup policy.


 
object (PolicyReplicaSettings) 
Specifies settings for snapshot replicas for the backup policy.


 
object (RetrySettings) 
Specifies retry settings configured for the backup policy.


 
object (Ec2SlaBasedNotificationSettings) 
 
object (ProductionWorkerSettings) 
 
object (OrganizationSpecification) 
[Applies only if you back up resources within an AWS Organization] Specifies organization settings configured for the backup policy.


 
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/policy/ec2SlaBasedPolicies
Request samples 
application/json
{
  • "name": "string",
  • "description": "string",
  • "identityId": "ebc92baa-b430-498d-b30d-132ff32a5256",
  • "backupType": "AllItems",
  • "selectedItems": {
    },
  • "excludedItems": {
    },
  • "regionIds": [
    ],
  • "storageTemplateId": "26065508-ceab-4f71-9405-88b494d18c99",
  • "slaTemplateId": "03e7c6bc-a285-4f16-8e6c-77435e1f6891",
  • "snapshotSettings": {
    },
  • "replicaSettings": {
    },
  • "retrySettings": {
    },
  • "notificationSettings": {
    },
  • "productionWorkersSettings": {
    },
  • "organizationSettings": {
    }
}
Response samples 
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "description": "string",
  • "priority": 0,
  • "isEnabled": true,
  • "identity": {
    },
  • "usn": 0,
  • "regionIds": [
    ],
  • "backupType": "AllItems",
  • "selectedItems": {
    },
  • "excludedItems": {
    },
  • "retrySettings": {
    },
  • "notificationSettings": {
    },
  • "warning": "string",
  • "storageTemplateId": "26065508-ceab-4f71-9405-88b494d18c99",
  • "slaTemplateId": "03e7c6bc-a285-4f16-8e6c-77435e1f6891",
  • "snapshotSettings": {
    },
  • "productionWorkersSettings": {
    },
  • "replicaSettings": {
    },
  • "organizationSettings": {
    }
}
Get SLA-Based Backup Policy Data
The HTTP GET request to the policy/ec2SlaBasedPolicies/{policyId} endpoint retrieves settings of an SLA-based backup policy with the specified ID.


SecurityBearer 
Request 
path Parameters
policyId
required
string <uuid> 
 
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/policy/ec2SlaBasedPolicies/{policyId}
Request samples 
Response samples 
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "description": "string",
  • "priority": 0,
  • "isEnabled": true,
  • "identity": {
    },
  • "usn": 0,
  • "regionIds": [
    ],
  • "backupType": "AllItems",
  • "selectedItems": {
    },
  • "excludedItems": {
    },
  • "retrySettings": {
    },
  • "notificationSettings": {
    },
  • "warning": "string",
  • "storageTemplateId": "26065508-ceab-4f71-9405-88b494d18c99",
  • "slaTemplateId": "03e7c6bc-a285-4f16-8e6c-77435e1f6891",
  • "snapshotSettings": {
    },
  • "productionWorkersSettings": {
    },
  • "replicaSettings": {
    },
  • "organizationSettings": {
    }
}
Modify SLA-Based Backup Policy
The HTTP PUT request to the policy/ec2SlaBasedPolicies/{policyId} endpoint updates settings of an SLA-based backup policy with the specified ID.


SecurityBearer 
Request 
path Parameters
policyId
required
string <uuid> 
 
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
regionIds
required
Array of strings <uuid>   non-empty  unique 
Specifies the system IDs assigned in the Veeam Backup for AWS REST API to AWS Regions where the backed-up instances reside.


 
name
required
string  [ 1 .. 255 ] characters 
Specifies a name of the SLA-based backup policy.


 
identityId
required
string <uuid> 
Specifies the system ID assigned in the Veeam Backup for AWS REST API to an AWS Organization or an IAM role that belongs to a standalone AWS account.


 
backupType
required
string (PolicySelectionTypes) 
Specifies the type of the backup policy.


 Enum: "AllItems" "SelectedItems"  
slaTemplateId
required
string <uuid> 
Specifies the system ID assigned in the Veeam Backup for AWS REST API to the SLA template assigned to the policy.


 
description
string
Specifies a description of the SLA-based backup policy.


 
object (Ec2PolicyIncludedBackupItems) 
AWS resources that are protected by the backup policy.


 
object (Ec2PolicyExcludedBackupItems) 
Specifies AWS resources that must be excluded from the backup policy.


 
storageTemplateId
string <uuid> 
Specifies the system ID assigned in the Veeam Backup for AWS REST API to the storage template assigned to the policy.


 
object (Ec2PolicySnapshotSettings) 
Specifies cloud-native snapshot settings for the EC2 backup policy.


 
object (PolicyReplicaSettings) 
Specifies settings for snapshot replicas for the backup policy.


 
object (RetrySettings) 
Specifies retry settings configured for the backup policy.


 
object (Ec2SlaBasedNotificationSettings) 
 
object (ProductionWorkerSettings) 
 
object (OrganizationSpecification) 
[Applies only if you back up resources within an AWS Organization] Specifies organization settings configured for the backup policy.


 
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/policy/ec2SlaBasedPolicies/{policyId}
Request samples 
application/json
{
  • "name": "string",
  • "description": "string",
  • "identityId": "ebc92baa-b430-498d-b30d-132ff32a5256",
  • "backupType": "AllItems",
  • "selectedItems": {
    },
  • "excludedItems": {
    },
  • "regionIds": [
    ],
  • "storageTemplateId": "26065508-ceab-4f71-9405-88b494d18c99",
  • "slaTemplateId": "03e7c6bc-a285-4f16-8e6c-77435e1f6891",
  • "snapshotSettings": {
    },
  • "replicaSettings": {
    },
  • "retrySettings": {
    },
  • "notificationSettings": {
    },
  • "productionWorkersSettings": {
    },
  • "organizationSettings": {
    }
}
Response samples 
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "description": "string",
  • "priority": 0,
  • "isEnabled": true,
  • "identity": {
    },
  • "usn": 0,
  • "regionIds": [
    ],
  • "backupType": "AllItems",
  • "selectedItems": {
    },
  • "excludedItems": {
    },
  • "retrySettings": {
    },
  • "notificationSettings": {
    },
  • "warning": "string",
  • "storageTemplateId": "26065508-ceab-4f71-9405-88b494d18c99",
  • "slaTemplateId": "03e7c6bc-a285-4f16-8e6c-77435e1f6891",
  • "snapshotSettings": {
    },
  • "productionWorkersSettings": {
    },
  • "replicaSettings": {
    },
  • "organizationSettings": {
    }
}
Delete SLA-Based Backup Policy
The HTTP DELETE request to the policy/ec2SlaBasedPolicies/{policyId} endpoint removes an SLA-based backup policy with the specified ID.


SecurityBearer 
Request 
path Parameters
policyId
required
string <uuid> 
Specifies the system ID assigned to an SLA-based policy 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/policy/ec2SlaBasedPolicies/{policyId}
Request samples 
Response samples 
application/json
{
  • "type": "http://example.com",
  • "title": "string",
  • "status": 400,
  • "errorCode": "AccessDenied",
  • "details": "string",
  • "instance": "http://example.com",
  • "data": {
    }
}
Get SLA Compliance Information
The HTTP GET request to the /policy/ec2SlaBasedPolicies/{policyId}/slaReport/ endpoint retrieves a list of SLA-based backup policies created in Veeam Backup for AWS and their SLA compliance information.


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.


 
Offset
integer <int32> 
Specifies the first N items of a resource collection that will be excluded from the response.


 
Limit
integer <int32> 
Specifies the maximum number of items of a resource collection that will be returned in the 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.


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/policy/ec2SlaBasedPolicies/{policyId}/slaReport
Request samples 
Response samples 
application/json
{
  • "totalCount": 0,
  • "results": [
    ]
}
Get Resources Excluded from SLA-Based Backup Policy
The HTTP GET request to the /policy/ec2SlaBasedPolicies/{policyId}/excludedItems endpoint retrieves information on resources excluded from the SLA-based backup policy with the specified ID.


SecurityBearer 
Request 
path Parameters
policyId
required
string <uuid> 
Specifies the system ID assigned to the SLA-Based policy in the Veeam Backup for AWS REST API.


 
query Parameters
Offset
integer <int32>   >= 0 
Excludes from a response the first N items of a resource collection.


 
Limit
integer <int32>   >= -1 
Specifies the maximum number of items of a resource collection to return in a response.


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


 
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
OK


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).


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 on the server side.


503
Service Unavailable


504
Gateway Timeout


get/api/v1/policy/ec2SlaBasedPolicies/{policyId}/excludedItems
Request samples 
Response samples 
{
  • "totalCount": 0,
  • "results": [
    ],
  • "_links": [
    ]
}
Get Resources Protected by SLA-Based Backup Policy
The HTTP GET request to the /policy/ec2SlaBasedPolicies/{policyId}/protectedResources endpoint retrieves information on resources protected by an SLA-based backup policy with the specified ID.


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


 
query Parameters
Offset
integer <int32>   >= 0 
Excludes from a response the first N items of a resource collection.


 
Limit
integer <int32>   >= -1 
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
OK


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).


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 on the server side.


503
Service Unavailable


504
Gateway Timeout


get/api/v1/policy/ec2SlaBasedPolicies/{policyId}/protectedResources
Request samples 
Response samples 
{
  • "totalCount": 0,
  • "results": [
    ],
  • "_links": [
    ]
}
Get AWS Regions Selected for SLA-Based Backup Policy
The HTTP GET request to the /policy/ec2SlaBasedPolicies/{policyId}/regions endpoint retrieves information on all AWS Regions selected for a SLA-based backup policy with the specified ID.


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


 
query Parameters
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
OK


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).


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 on the server side.


503
Service Unavailable


504
Gateway Timeout


get/api/v1/policy/ec2SlaBasedPolicies/{policyId}/regions
Request samples 
Response samples 
{
  • "totalCount": 0,
  • "results": [
    ],
  • "_links": [
    ]
}
Enable SLA-Based Backup Policy
The HTTP POST request to the /policy/ec2SlaBasedPolicies/{policyId}/enable endpoint enables a disabled SLA-based backup policy with the specified ID.


SecurityBearer 
Request 
path Parameters
policyId
required
string <uuid> 
Specifies the system ID assigned to an SLA-based backup policy 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
OK


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


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 on the server side.


503
Service Unavailable


504
Gateway Timeout


post/api/v1/policy/ec2SlaBasedPolicies/{policyId}/enable
Request samples 
Response samples 
{
  • "type": "http://example.com",
  • "title": "string",
  • "status": 400,
  • "errorCode": "AccessDenied",
  • "details": "string",
  • "instance": "http://example.com",
  • "data": {
    }
}
Disable SLA-Based Backup Policy
The HTTP POST request to the /policy/ec2SlaBasedPolicies/{policyId}/disable endpoint disables an enabled SLA-based backup policy with the specified ID.


SecurityBearer 
Request 
path Parameters
policyId
required
string <uuid> 
Specifies the system ID assigned to an SLA-based policy 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
OK


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


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 on the server side.


503
Service Unavailable


504
Gateway Timeout


post/api/v1/policy/ec2SlaBasedPolicies/{policyId}/disable
Request samples 
Response samples 
{
  • "type": "http://example.com",
  • "title": "string",
  • "status": 400,
  • "errorCode": "AccessDenied",
  • "details": "string",
  • "instance": "http://example.com",
  • "data": {
    }
}
Set SLA-Based Backup Policy Priority
The HTTP POST request to the /policy/ec2SlaBasedPolicies/orderPriorities sets the priority order for SLA-based backup policies.


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
required
Array of objects (PolicyPrioritySpec) 
Specifies policy priority ordinal numbers.


 
Responses 
200
OK


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 on the server side.


503
Service Unavailable


504
Gateway Timeout


post/api/v1/policy/ec2SlaBasedPolicies/orderPriorities
Request samples 
application/json
{
  • "priorities": [
    ]
}
Response samples 
{ }
Export Collection of SLA-Based Backup Policies
The HTTP POST request to the /api/v1/policy/ec2SlaBasedPolicies/export endpoint exports all SLA-based backup policies created in Veeam Backup for AWS to a .CSV or an .XML file. To specify the required type of the file, use the Accept request header.


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.


 
Responses 
200
OK


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


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


503
Service Unavailable


504
Gateway Timeout


post/api/v1/policy/ec2SlaBasedPolicies/export
Request samples 
Calculate Estimated Cost for SLA-Based Policy
The HTTP POST request to the /policy/ec2SlaBasedPolicies/cost endpoint allows you to calculate the estimated monthly cost for an SLA-based policy with specific settings.


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
regionIds
required
Array of strings <uuid>   non-empty  unique 
Specifies the system IDs assigned in the Veeam Backup for AWS REST API to AWS Regions where the backed-up instances reside.


 
name
required
string  [ 1 .. 255 ] characters 
Specifies a name of the SLA-based backup policy.


 
identityId
required
string <uuid> 
Specifies the system ID assigned in the Veeam Backup for AWS REST API to an AWS Organization or an IAM role that belongs to a standalone AWS account.


 
backupType
required
string (PolicySelectionTypes) 
Specifies the type of the backup policy.


 Enum: "AllItems" "SelectedItems"  
slaTemplateId
required
string <uuid> 
Specifies the system ID assigned in the Veeam Backup for AWS REST API to the SLA template assigned to the policy.


 
description
string
Specifies a description of the SLA-based backup policy.


 
object (Ec2PolicyIncludedBackupItems) 
AWS resources that are protected by the backup policy.


 
object (Ec2PolicyExcludedBackupItems) 
Specifies AWS resources that must be excluded from the backup policy.


 
storageTemplateId
string <uuid> 
Specifies the system ID assigned in the Veeam Backup for AWS REST API to the storage template assigned to the policy.


 
object (Ec2PolicySnapshotSettings) 
Specifies cloud-native snapshot settings for the EC2 backup policy.


 
object (PolicyReplicaSettings) 
Specifies settings for snapshot replicas for the backup policy.


 
object (RetrySettings) 
Specifies retry settings configured for the backup policy.


 
object (Ec2SlaBasedNotificationSettings) 
 
object (ProductionWorkerSettings) 
 
object (OrganizationSpecification) 
[Applies only if you back up resources within an AWS Organization] Specifies organization settings configured for the backup policy.


 
Responses 
200
OK


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).


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


503
Service Unavailable


504
Gateway Timeout


post/api/v1/policy/ec2SlaBasedPolicies/cost
Request samples 
application/json
{
  • "name": "string",
  • "description": "string",
  • "identityId": "ebc92baa-b430-498d-b30d-132ff32a5256",
  • "backupType": "AllItems",
  • "selectedItems": {
    },
  • "excludedItems": {
    },
  • "regionIds": [
    ],
  • "storageTemplateId": "26065508-ceab-4f71-9405-88b494d18c99",
  • "slaTemplateId": "03e7c6bc-a285-4f16-8e6c-77435e1f6891",
  • "snapshotSettings": {
    },
  • "replicaSettings": {
    },
  • "retrySettings": {
    },
  • "notificationSettings": {
    },
  • "productionWorkersSettings": {
    },
  • "organizationSettings": {
    }
}
Response samples 
{
  • "instancesCosts": [
    ],
  • "isEmpty": true,
  • "totalSnapshotCost": 0,
  • "totalReplicaCost": 0,
  • "totalBackupCost": 0,
  • "totalBackupCopyCost": 0,
  • "totalTrafficCost": 0,
  • "totalTransactionCost": 0,
  • "totalCost": 0
}
Get SLA-Based Backup Policy Estimated Cost
The HTTP GET request to the /policy/ec2SlaBasedPolicies/{policyId}/cost endpoint retrieves estimated monthly cost calculated for an SLA-based backup policy with the specified ID.


SecurityBearer 
Request 
path Parameters
policyId
required
string <uuid> 
Specifies the system ID assigned to an SLA-based backup policy 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
OK


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


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 on the server side.


503
Service Unavailable


504
Gateway Timeout


get/api/v1/policy/ec2SlaBasedPolicies/{policyId}/cost
Request samples 
Response samples 
{
  • "instancesCosts": [
    ],
  • "isEmpty": true,
  • "totalSnapshotCost": 0,
  • "totalReplicaCost": 0,
  • "totalBackupCost": 0,
  • "totalBackupCopyCost": 0,
  • "totalTrafficCost": 0,
  • "totalTransactionCost": 0,
  • "totalCost": 0
}
Get SLA Results per Period
The HTTP GET request to the /policy/ec2SlaBasedPolicies/{policyId}/slaResults/ endpoint retrieves information on each available calculated period (day, week or month) of a specific schedule type configured for 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 AWS REST API.


 
query Parameters
ec2SlaFilterSessionStatus
Array of strings
Returns only information on periods that have the specified SLA compliance status.


Items Enum: "MetSla" "MissedSla" "All"  
backupType
Array of strings
Returns only information on the specified backup type.


Items Enum: "Snapshot" "Backup" "Archive" "Replica"  
scheduleType
Array of strings
Returns only information on the specified schedule type.


Items Enum: "Daily" "Weekly" "Monthly"  
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/policy/ec2SlaBasedPolicies/{policyId}/slaResults
Request samples 
Response samples 
application/json
{
  • "totalCount": 0,
  • "results": [
    ]
}
Get SLA Compliance per EC2 Instance
The HTTP GET request to the /policy/ec2SlaBasedPolicies/{policyId}/slaInstances endpoint retrieves SLA compliance information on each EC2 instance 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 an SLA-based backup policy in the Veeam Backup for AWS REST API.


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


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


 
slaComplianceStatus
Array of strings
Returns information on EC2 instance with the specified SLA compliance status only.


Items Enum: "All" "MetSla" "MissedSla" "Removed"  
backupType
Array of strings
Returns only information on EC2 instances protected using the specified backup type.


Items Enum: "Snapshot" "Backup" "Archive" "Replica"  
scheduleType
Array of strings
Returns only information on EC2 instances protected using the specified schedule type.


Items Enum: "Daily" "Weekly" "Monthly"  
searchPattern
string
Returns only those items of a resource collection whose names match the specified search pattern in the parameter value.


 
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.


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/policy/ec2SlaBasedPolicies/{policyId}/slaInstances
Request samples 
Response samples 
application/json
{
  • "statistics": {
    },
  • "results": [
    ]
}
Get SLA-Based Backup Policy Sessions per EC2 instance
The HTTP GET request to the policy/ec2SlaBasedPolicies/{policyId}/slaSessions/{instanceId} endpoint retrieves information on each session performed for a specific EC2 instance 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 an SLA-based backup policy in the Veeam Backup for AWS REST API.


 
instanceId
required
string <uuid> 
Specifies a system ID assigned to the protected EC2 instance in the Veeam Backup for AWS REST API.


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


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


 
backupType
Array of strings
Returns only sessions of the EC2 instances protected using the specified backup type.


Items Enum: "Snapshot" "Backup" "Archive" "Replica"  
scheduleType
Array of strings
Returns only sessions of the EC2 instances protected using the specified schedule type.


Items Enum: "Daily" "Weekly" "Monthly"  
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.


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/policy/ec2SlaBasedPolicies/{policyId}/slaSessions/{instanceId}
Request samples 
Response samples 
application/json
{
  • "totalCount": 0,
  • "results": [
    ]
}
Get SLA-Based Backup Policy Session Log per EC2 Instance
The HTTP GET request to the policy/ec2SlaBasedPolicies/slaSessions/{sessionId}/slaSessionLogs endpoint retrieves a detailed log for the session with the specified ID, performed for a specific EC2 instance.


SecurityBearer 
Request 
path Parameters
sessionId
required
string <uuid> 
Specifies a system ID assigned to the session 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/policy/ec2SlaBasedPolicies/slaSessions/{sessionId}/slaSessionLogs
Request samples 
Response samples 
application/json
{
  • "totalCount": 0,
  • "results": [
    ]
}