Veeam Backup for AWS 9
REST API Reference
Related documents

EFS Backup Policies

The /efs/policies resource collection represents EFS backup policies created in Veeam Backup for AWS.

Get Collection of EFS Backup Policies

The HTTP GET request to the /efs/policies endpoint retrieves a list of all EFS 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.

EfsId
string <uuid>

Returns only backup policies that protect a file system with the specified ID.

IsEnabled
boolean

Returns only enabled or disabled backup policies.

LastPolicySessionStatus
Array of strings

Returns only backup policies with the specified most recent backup session status.

Items Enum: "Running" "NeverExecuted" "Succeeded" "Warning" "Failed" "Canceled"
Sort
Array of strings (PoliciesSortColumns)

Specifies the order of items in the response. For more information, see the Veeam Backup for AWS REST API Reference Overview, section Sort Parameter.

Items Enum: "priorityAsc" "priorityDesc" "nameAsc" "nameDesc" "usnAsc" "usnDesc"
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.7-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/efs/policies
Request samples 
curl -i -X GET \
  'https://helpcenter.veeam.com/api/v1/efs/policies?SearchPattern=string&EfsId=497f6eca-6276-4993-bfeb-53cbbbba6f08&IsEnabled=true&LastPolicySessionStatus=Running&Sort=priorityAsc&Offset=0&Limit=-1' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'x-api-version: 1.7-rev0'
Response samples
{
  • "totalCount": 0,
  • "results": [
    ],
  • "_links": [
    ]
}

Create Backup Policy

The HTTP POST request to the /efs/policies endpoint creates a new EFS backup policy.

SecurityBearer
Request
header Parameters
x-api-version
required
string
Default: 1.7-rev0

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

Request Body schema:
required
name
required
string

Specifies a name for the backup policy.

identityId
required
string <uuid>

Specifies a system ID assigned in the Veeam Backup for AWS REST API to an AWS Organization or an IAM role that belongs to an AWS account.

required
Array of objects (EfsPolicyRegion) non-empty

Specifies backup settings configured for the backup policy.

backupType
required
string (PolicySelectionTypes)

Specifies the type of the backup policy.

Enum: "AllItems" "SelectedItems"
description
string

Specifies a description for the backup policy.

priority
integer <int64>

Specifies the priority order number for the backup policy.

isEnabled
boolean

Defines whether the backup policy is enabled.

object (EfsPolicyIncludedBackupItems)

AWS resources that are protected by the backup policy.

object (EfsPolicyExcludedBackupItems)

Specifies AWS resources that must be excluded from the backup policy.

object (EfsPolicyBackupSettings)

Tag settings configured for the policy.

object (EfsPolicyBackupIndexingSettings)

[Applies only if the policy must perform indexing for the processed file systems] Specifies the indexing settings configured for the policy.

object (EfsPolicyBackupCopySettings)

Backup copy settings configured for the backup policy.

object (EfsScheduleSettings)

Backup schedule specified for the backup policy.

object (RetrySettings)

Specifies retry settings configured for the backup policy.

object (NotificationSettings)

Specifies retry and notification settings for the backup policy.

object (OrganizationSpecification)

[Applies only if you back up resources within an AWS Organization] Specifies organization settings configured for the backup policy.

Responses
201

Created

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/efs/policies
Request samples
{
  • "name": "string",
  • "description": "string",
  • "priority": 0,
  • "identityId": "ebc92baa-b430-498d-b30d-132ff32a5256",
  • "isEnabled": true,
  • "regions": [
    ],
  • "backupType": "AllItems",
  • "selectedItems": {
    },
  • "excludedItems": {
    },
  • "backupSettings": {
    },
  • "backupIndexingSettings": {
    },
  • "backupCopySettings": {
    },
  • "scheduleSettings": {
    },
  • "retrySettings": {
    },
  • "notificationSettings": {
    },
  • "organizationSettings": {
    }
}
Response samples
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "description": "string",
  • "priority": 0,
  • "identity": {
    },
  • "regions": [
    ],
  • "backupType": "AllItems",
  • "selectedItems": {
    },
  • "excludedItems": {
    },
  • "backupSettings": {
    },
  • "backupIndexingSettings": {
    },
  • "backupCopySettings": {
    },
  • "scheduleSettings": {
    },
  • "retrySettings": {
    },
  • "notificationSettings": {
    },
  • "organizationSettings": {
    },
  • "isEnabled": true,
  • "createdBy": "string",
  • "modifiedBy": "string",
  • "lastPolicySessionStatus": "Running",
  • "warning": "string",
  • "usn": 0,
  • "_embeddedResources": {
    },
  • "_links": [
    ]
}

Get Backup Policy Data

The HTTP GET request to the /efs/policies/{policyId} endpoint retrieves settings of an EFS backup policy with the specified ID.

SecurityBearer
Request
path Parameters
policyId
required
string <uuid>

Specifies the system ID assigned to an EFS backup policy in the Veeam Backup for AWS REST API.

header Parameters
x-api-version
required
string
Default: 1.7-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/efs/policies/{policyId}
Request samples 
curl -i -X GET \
  'https://helpcenter.veeam.com/api/v1/efs/policies/{policyId}' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'x-api-version: 1.7-rev0'
Response samples
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "description": "string",
  • "priority": 0,
  • "identity": {
    },
  • "regions": [
    ],
  • "backupType": "AllItems",
  • "selectedItems": {
    },
  • "excludedItems": {
    },
  • "backupSettings": {
    },
  • "backupIndexingSettings": {
    },
  • "backupCopySettings": {
    },
  • "scheduleSettings": {
    },
  • "retrySettings": {
    },
  • "notificationSettings": {
    },
  • "organizationSettings": {
    },
  • "isEnabled": true,
  • "createdBy": "string",
  • "modifiedBy": "string",
  • "lastPolicySessionStatus": "Running",
  • "warning": "string",
  • "usn": 0,
  • "_embeddedResources": {
    },
  • "_links": [
    ]
}

Modify Backup Policy

The HTTP PUT request to the /efs/policies/{policyId} endpoint updates settings of an EFS backup policy with the specified ID.

SecurityBearer
Request
path Parameters
policyId
required
string <uuid>

Specifies the system ID assigned to an EFS backup policy in the Veeam Backup for AWS REST API.

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

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

Request Body schema:
required
name
required
string

Specifies a name for the backup policy.

identityId
required
string <uuid>

Specifies a system ID assigned in the Veeam Backup for AWS REST API to an AWS Organization or an IAM role that belongs to an AWS account.

required
Array of objects (EfsPolicyRegion) non-empty

Specifies backup settings configured for the backup policy.

backupType
required
string (PolicySelectionTypes)

Specifies the type of the backup policy.

Enum: "AllItems" "SelectedItems"
description
string

Specifies a description for the backup policy.

priority
integer <int64>

Specifies the priority order number for the backup policy.

isEnabled
boolean

Defines whether the backup policy is enabled.

object (EfsPolicyIncludedBackupItems)

AWS resources that are protected by the backup policy.

object (EfsPolicyExcludedBackupItems)

Specifies AWS resources that must be excluded from the backup policy.

object (EfsPolicyBackupSettings)

Tag settings configured for the policy.

object (EfsPolicyBackupIndexingSettings)

[Applies only if the policy must perform indexing for the processed file systems] Specifies the indexing settings configured for the policy.

object (EfsPolicyBackupCopySettings)

Backup copy settings configured for the backup policy.

object (EfsScheduleSettings)

Backup schedule specified for the backup policy.

object (RetrySettings)

Specifies retry settings configured for the backup policy.

object (NotificationSettings)

Specifies retry and notification settings for the backup policy.

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

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

put/api/v1/efs/policies/{policyId}
Request samples
{
  • "name": "string",
  • "description": "string",
  • "priority": 0,
  • "identityId": "ebc92baa-b430-498d-b30d-132ff32a5256",
  • "isEnabled": true,
  • "regions": [
    ],
  • "backupType": "AllItems",
  • "selectedItems": {
    },
  • "excludedItems": {
    },
  • "backupSettings": {
    },
  • "backupIndexingSettings": {
    },
  • "backupCopySettings": {
    },
  • "scheduleSettings": {
    },
  • "retrySettings": {
    },
  • "notificationSettings": {
    },
  • "organizationSettings": {
    }
}
Response samples
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "description": "string",
  • "priority": 0,
  • "identity": {
    },
  • "regions": [
    ],
  • "backupType": "AllItems",
  • "selectedItems": {
    },
  • "excludedItems": {
    },
  • "backupSettings": {
    },
  • "backupIndexingSettings": {
    },
  • "backupCopySettings": {
    },
  • "scheduleSettings": {
    },
  • "retrySettings": {
    },
  • "notificationSettings": {
    },
  • "organizationSettings": {
    },
  • "isEnabled": true,
  • "createdBy": "string",
  • "modifiedBy": "string",
  • "lastPolicySessionStatus": "Running",
  • "warning": "string",
  • "usn": 0,
  • "_embeddedResources": {
    },
  • "_links": [
    ]
}

Delete Backup Policy

The HTTP DELETE request to the /efs/policies/{policyId} endpoint deletes an EFS backup policy with the specified ID.

NOTE
When you delete a backup policy, cloud-native snapshots, and snapshot replicas or image-level backups created by this backup policy remain intact in AWS. Such snapshots, replicas and backups are not deleted from the configuration database — you can find them in the Protected Data view.

SecurityBearer
Request
path Parameters
policyId
required
string <uuid>

Specifies the system ID assigned to an EFS backup policy in the Veeam Backup for AWS REST API.

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

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

Responses
204

No Content

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.

409

Failed to delete policy, verify it is not in use and try again.

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

delete/api/v1/efs/policies/{policyId}
Request samples 
curl -i -X DELETE \
  'https://helpcenter.veeam.com/api/v1/efs/policies/{policyId}' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'x-api-version: 1.7-rev0'
Response samples
{
  • "type": "http://example.com",
  • "title": "string",
  • "status": 400,
  • "errorCode": "AccessDenied",
  • "details": "string",
  • "instance": "http://example.com",
  • "data": {
    }
}

Get Resources Protected by Backup Policy

The HTTP GET request to the /efs/policies/{policyId}/selectedItems endpoint retrieves information on all AWS resources protected by an EFS backup policy with the specified ID.

SecurityBearer
Request
path Parameters
policyId
required
string <uuid>

Specifies the system ID assigned to an EFS 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.

SearchPattern
string

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

Sort
Array of strings (PolicyItemsSortColumns)

Specifies the order of items in the response. For more information, see the Veeam Backup for AWS REST API Reference Overview, section Sort Parameter.

Items Enum: "nameAsc" "nameDesc"
header Parameters
x-api-version
required
string
Default: 1.7-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/efs/policies/{policyId}/selectedItems
Request samples 
curl -i -X GET \
  'https://helpcenter.veeam.com/api/v1/efs/policies/{policyId}/selectedItems?Offset=0&Limit=-1&SearchPattern=string&Sort=nameAsc' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'x-api-version: 1.7-rev0'
Response samples
{
  • "totalCount": 0,
  • "results": [
    ],
  • "_links": [
    ]
}

Get Resources Excluded from Backup Policy

The HTTP GET request to the /efs/policies/{policyId}/excludedItems endpoint retrieves information on all AWS resources excluded from an EFS backup policy with the specified ID.

SecurityBearer
Request
path Parameters
policyId
required
string <uuid>

Specifies the system ID assigned to an EFS 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.

SearchPattern
string

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

Sort
Array of strings (PolicyItemsSortColumns)

Specifies the order of items in the response. For more information, see the Veeam Backup for AWS REST API Reference Overview, section Sort Parameter.

Items Enum: "nameAsc" "nameDesc"
header Parameters
x-api-version
required
string
Default: 1.7-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/efs/policies/{policyId}/excludedItems
Request samples 
curl -i -X GET \
  'https://helpcenter.veeam.com/api/v1/efs/policies/{policyId}/excludedItems?Offset=0&Limit=-1&SearchPattern=string&Sort=nameAsc' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'x-api-version: 1.7-rev0'
Response samples
{
  • "totalCount": 0,
  • "results": [
    ],
  • "_links": [
    ]
}

Get Resources Protected by EFS Backup Policy

The HTTP GET request to the /efs/policies/{policyId}/protectedResources endpoint retrieves information on all AWS resources protected by an EFS backup policy with the specified ID.

SecurityBearer
Request
path Parameters
policyId
required
string <uuid>

Specifies the system ID assigned to an EFS 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.

Sort
Array of strings (PolicyProtectedResourcesSortColumns)

Specifies the order of items in the response. For more information, see the Veeam Backup for AWS REST API Reference Overview, section Sort Parameter.

Items Enum: "idAsc" "idDesc" "awsResourceIdAsc" "awsResourceIdDesc"
header Parameters
x-api-version
required
string
Default: 1.7-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/efs/policies/{policyId}/protectedResources
Request samples 
curl -i -X GET \
  'https://helpcenter.veeam.com/api/v1/efs/policies/{policyId}/protectedResources?Offset=0&Limit=-1&Sort=idAsc' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'x-api-version: 1.7-rev0'
Response samples
{
  • "totalCount": 0,
  • "results": [
    ],
  • "_links": [
    ]
}

Get AWS Regions Selected for Backup Policy

The HTTP GET request to the /efs/policies/{policyId}/regions endpoint retrieves information on all AWS Regions selected for an EFS backup policy with the specified ID.

SecurityBearer
Request
path Parameters
policyId
required
string <uuid>

Specifies the system ID assigned to an EFS backup policy in the Veeam Backup for AWS REST API.

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>

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.

Sort
Array of strings (RegionsSortColumns)

Specifies the order of items in the response. For more information, see the Veeam Backup for AWS REST API Reference Overview, section Sort Parameter.

Items Enum: "nameAsc" "nameDesc"
header Parameters
x-api-version
required
string
Default: 1.7-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/efs/policies/{policyId}/regions
Request samples 
curl -i -X GET \
  'https://helpcenter.veeam.com/api/v1/efs/policies/{policyId}/regions?SearchPattern=string&Offset=0&Limit=0&Sort=nameAsc' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'x-api-version: 1.7-rev0'
Response samples
{
  • "totalCount": 0,
  • "results": [
    ],
  • "_links": [
    ]
}

Enable Backup Policy

The HTTP POST request to the efs/policies/{policyId}/enable endpoint enables a disabled EFS backup policy with the specified ID.

SecurityBearer
Request
path Parameters
policyId
required
string <uuid>

Specifies the system ID assigned to an EFS backup policy in the Veeam Backup for AWS REST API.

header Parameters
x-api-version
required
string
Default: 1.7-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/efs/policies/{policyId}/enable
Request samples 
curl -i -X POST \
  'https://helpcenter.veeam.com/api/v1/efs/policies/{policyId}/enable' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'x-api-version: 1.7-rev0'
Response samples
{
  • "type": "http://example.com",
  • "title": "string",
  • "status": 400,
  • "errorCode": "AccessDenied",
  • "details": "string",
  • "instance": "http://example.com",
  • "data": {
    }
}

Disable Backup Policy

The HTTP POST request to the /efs/policies/{policyId}/disable endpoint disables an enabled EFS backup policy with the specified ID.

SecurityBearer
Request
path Parameters
policyId
required
string <uuid>

Specifies the system ID assigned to an EFS backup policy in the Veeam Backup for AWS REST API.

header Parameters
x-api-version
required
string
Default: 1.7-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/efs/policies/{policyId}/disable
Request samples 
curl -i -X POST \
  'https://helpcenter.veeam.com/api/v1/efs/policies/{policyId}/disable' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'x-api-version: 1.7-rev0'
Response samples
{
  • "type": "http://example.com",
  • "title": "string",
  • "status": 400,
  • "errorCode": "AccessDenied",
  • "details": "string",
  • "instance": "http://example.com",
  • "data": {
    }
}

Start Backup Policy

The HTTP POST request to the /efs/policies/{policyId}/start endpoint launches an EFS backup policy with the specified ID.

SecurityBearer
Request
path Parameters
policyId
required
string <uuid>

Specifies the system ID assigned to an EFS backup policy in the Veeam Backup for AWS REST API.

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

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

Responses
202

Accepted

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.

409

The policy has already started.

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/efs/policies/{policyId}/start
Request samples 
curl -i -X POST \
  'https://helpcenter.veeam.com/api/v1/efs/policies/{policyId}/start' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'x-api-version: 1.7-rev0'
Response samples
{}

Stop Backup Policy

The HTTP POST request to the /efs/policies/{policyId}/stop endpoint stops execution of an EFS backup policy with the specified ID.

SecurityBearer
Request
path Parameters
policyId
required
string <uuid>

Specifies the system ID assigned to an EFS backup policy in the Veeam Backup for AWS REST API.

header Parameters
x-api-version
required
string
Default: 1.7-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/efs/policies/{policyId}/stop
Request samples 
curl -i -X POST \
  'https://helpcenter.veeam.com/api/v1/efs/policies/{policyId}/stop' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'x-api-version: 1.7-rev0'
Response samples
{
  • "type": "http://example.com",
  • "title": "string",
  • "status": 400,
  • "errorCode": "AccessDenied",
  • "details": "string",
  • "instance": "http://example.com",
  • "data": {
    }
}

Calculate Estimated Cost for Backup Policy

The HTTP POST request to the /efs/policies/cost endpoint allows you to calculate the estimated monthly cost for an EFS backup policy with specific settings.

SecurityBearer
Request
header Parameters
x-api-version
required
string
Default: 1.7-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 backup policy.

identityId
required
string <uuid>

Specifies a system ID assigned in the Veeam Backup for AWS REST API to an AWS Organization or an IAM role that belongs to an AWS account.

required
Array of objects (EfsPolicyRegion) non-empty

Specifies backup settings configured for the backup policy.

backupType
required
string (PolicySelectionTypes)

Specifies the type of the backup policy.

Enum: "AllItems" "SelectedItems"
description
string

Specifies a description for the backup policy.

priority
integer <int64>

Specifies the priority order number for the backup policy.

isEnabled
boolean

Defines whether the backup policy is enabled.

object (EfsPolicyIncludedBackupItems)

AWS resources that are protected by the backup policy.

object (EfsPolicyExcludedBackupItems)

Specifies AWS resources that must be excluded from the backup policy.

object (EfsPolicyBackupSettings)

Tag settings configured for the policy.

object (EfsPolicyBackupIndexingSettings)

[Applies only if the policy must perform indexing for the processed file systems] Specifies the indexing settings configured for the policy.

object (EfsPolicyBackupCopySettings)

Backup copy settings configured for the backup policy.

object (EfsScheduleSettings)

Backup schedule specified for the backup policy.

object (RetrySettings)

Specifies retry settings configured for the backup policy.

object (NotificationSettings)

Specifies retry and notification settings for the backup policy.

object (OrganizationSpecification)

[Applies only if you back up resources within an AWS Organization] Specifies organization settings configured for the backup policy.

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/efs/policies/cost
Request samples
application/json
{
  • "name": "string",
  • "description": "string",
  • "priority": 0,
  • "identityId": "ebc92baa-b430-498d-b30d-132ff32a5256",
  • "isEnabled": true,
  • "regions": [
    ],
  • "backupType": "AllItems",
  • "selectedItems": {
    },
  • "excludedItems": {
    },
  • "backupSettings": {
    },
  • "backupIndexingSettings": {
    },
  • "backupCopySettings": {
    },
  • "scheduleSettings": {
    },
  • "retrySettings": {
    },
  • "notificationSettings": {
    },
  • "organizationSettings": {
    }
}
Response samples
{
  • "instancesCosts": [
    ],
  • "isEmpty": true,
  • "totalBackupCost": 0,
  • "totalBackupCopyCost": 0,
  • "totalTrafficCost": 0,
  • "totalCost": 0,
  • "_links": [
    ]
}

Get Backup Policy Estimated Cost

The HTTP GET request to the efs/policies/{policyId}/cost endpoint retrieves estimated monthly cost calculated for an EFS backup policy with the specified ID.

SecurityBearer
Request
path Parameters
policyId
required
string <uuid>

Specifies the system ID assigned to an EFS backup policy in the Veeam Backup for AWS REST API.

header Parameters
x-api-version
required
string
Default: 1.7-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/efs/policies/{policyId}/cost
Request samples 
curl -i -X GET \
  'https://helpcenter.veeam.com/api/v1/efs/policies/{policyId}/cost' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'x-api-version: 1.7-rev0'
Response samples
{
  • "instancesCosts": [
    ],
  • "isEmpty": true,
  • "totalBackupCost": 0,
  • "totalBackupCopyCost": 0,
  • "totalTrafficCost": 0,
  • "totalCost": 0,
  • "_links": [
    ]
}

Validate Backup Policy Settings

The HTTP POST request to the /efs/policies/validate checks whether the settings you plan to specify for an EFS backup policy are valid.

SecurityBearer
Request
header Parameters
x-api-version
required
string
Default: 1.7-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 backup policy.

identityId
required
string <uuid>

Specifies a system ID assigned in the Veeam Backup for AWS REST API to an AWS Organization or an IAM role that belongs to an AWS account.

required
Array of objects (EfsPolicyRegion) non-empty

Specifies backup settings configured for the backup policy.

backupType
required
string (PolicySelectionTypes)

Specifies the type of the backup policy.

Enum: "AllItems" "SelectedItems"
description
string

Specifies a description for the backup policy.

priority
integer <int64>

Specifies the priority order number for the backup policy.

isEnabled
boolean

Defines whether the backup policy is enabled.

object (EfsPolicyIncludedBackupItems)

AWS resources that are protected by the backup policy.

object (EfsPolicyExcludedBackupItems)

Specifies AWS resources that must be excluded from the backup policy.

object (EfsPolicyBackupSettings)

Tag settings configured for the policy.

object (EfsPolicyBackupIndexingSettings)

[Applies only if the policy must perform indexing for the processed file systems] Specifies the indexing settings configured for the policy.

object (EfsPolicyBackupCopySettings)

Backup copy settings configured for the backup policy.

object (EfsScheduleSettings)

Backup schedule specified for the backup policy.

object (RetrySettings)

Specifies retry settings configured for the backup policy.

object (NotificationSettings)

Specifies retry and notification settings for the backup policy.

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

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/efs/policies/validate
Request samples
application/json
{
  • "name": "string",
  • "description": "string",
  • "priority": 0,
  • "identityId": "ebc92baa-b430-498d-b30d-132ff32a5256",
  • "isEnabled": true,
  • "regions": [
    ],
  • "backupType": "AllItems",
  • "selectedItems": {
    },
  • "excludedItems": {
    },
  • "backupSettings": {
    },
  • "backupIndexingSettings": {
    },
  • "backupCopySettings": {
    },
  • "scheduleSettings": {
    },
  • "retrySettings": {
    },
  • "notificationSettings": {
    },
  • "organizationSettings": {
    }
}
Response samples
[
  • {
    }
]

Set Backup Policy Priority

The HTTP POST request to the efs/policies/orderPriorities sets the priority order for EFS backup policies.

SecurityBearer
Request
header Parameters
x-api-version
required
string
Default: 1.7-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/efs/policies/orderPriorities
Request samples
application/json
{
  • "priorities": [
    ]
}
Response samples
{ }

Export Backup Policy Settings

The HTTP GET request to the efs/policies/{policyId}/export exports settings of an enabled EFS backup policy with the specified ID to a JSON file.

SecurityBearer
Request
path Parameters
policyId
required
string <uuid>

Specifies the system ID assigned to an EFS backup policy in the Veeam Backup for AWS REST API.

header Parameters
x-api-version
required
string
Default: 1.7-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).

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

503

Service Unavailable

504

Gateway Timeout

get/api/v1/efs/policies/{policyId}/export
Request samples 
curl -i -X GET \
  'https://helpcenter.veeam.com/api/v1/efs/policies/{policyId}/export' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'x-api-version: 1.7-rev0'
Response samples
{
  • "name": "string",
  • "description": "string",
  • "priority": 0,
  • "isEnabled": true,
  • "identityName": "string",
  • "regions": [
    ],
  • "backupType": "AllItems",
  • "selectedItems": {
    },
  • "excludedItems": {
    },
  • "backupSettings": {
    },
  • "backupIndexingSettings": {
    },
  • "backupCopySettings": {
    },
  • "scheduleSettings": {
    },
  • "retrySettings": {
    },
  • "notificationSettings": {
    },
  • "organizationSettings": {
    }
}

Import Backup Policy Settings

The HTTP POST request to the efs/policies/import creates an EFS backup policy with imported settings.

SecurityBearer
Request
header Parameters
x-api-version
required
string
Default: 1.7-rev0

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

Request Body schema: application/json
required
name
required
string

Name of the backup policy.

identityName
required
string

Specifies the name of an AWS Organization or the name of an IAM role that belongs to an AWS account.

required
Array of objects (EfsPolicyExportRegion) non-empty

Backup settings configured for the backup policy.

backupType
required
string (PolicySelectionTypes)

Specifies the type of the backup policy.

Enum: "AllItems" "SelectedItems"
description
string

Description of the backup policy.

priority
integer <int64>

Priority order number of the backup policy.

isEnabled
boolean

Defines whether the backup policy is enabled.

object (EfsPolicySelectedItemsExportModel)

AWS resources protected by the backup policy.

object (EfsPolicyExcludedItemsExportModel)

AWS resources excluded from the backup policy.

object (EfsPolicyBackupSettings)

Tag settings configured for the policy.

object (EfsPolicyBackupIndexingExportSettings)

[Applies only if the policy must perform indexing for the processed file systems] Specifies the indexing settings configured for the policy.

object (EfsPolicyBackupCopyExportSettings)

Backup copy settings configured for the backup policy.

object (EfsScheduleSettings)

Backup schedule specified for the backup policy.

object (RetrySettings)

Specifies retry settings configured for the backup policy.

object (NotificationSettings)

Specifies retry and notification settings for the backup policy.

object (OrganizationSettingsExportModel)

[Applies if an AWS Organization is added to Veeam Backup for AWS] Specifies organization settings configured for the backup policy.

Responses
202

Accepted

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

503

Service Unavailable

504

Gateway Timeout

post/api/v1/efs/policies/import
Request samples
application/json
{
  • "name": "string",
  • "description": "string",
  • "priority": 0,
  • "isEnabled": true,
  • "identityName": "string",
  • "regions": [
    ],
  • "backupType": "AllItems",
  • "selectedItems": {
    },
  • "excludedItems": {
    },
  • "backupSettings": {
    },
  • "backupIndexingSettings": {
    },
  • "backupCopySettings": {
    },
  • "scheduleSettings": {
    },
  • "retrySettings": {
    },
  • "notificationSettings": {
    },
  • "organizationSettings": {
    }
}
Response samples
{}

Export Collection of Backup Policies

The HTTP POST request to the /efs/policies/export endpoint exports all EFS 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.7-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/efs/policies/export
Request samples 
curl -i -X POST \
  https://helpcenter.veeam.com/api/v1/efs/policies/export \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'x-api-version: 1.7-rev0'