Veeam Backup for AWS 9
REST API Reference
Related documents

EFS Restore Points

The /efs/restorePoints resource collection represents all restore points created for EFS file systems in Veeam Backup for AWS.

Get EFS Restore Points

The HTTP GET request to the /efs/restorePoints endpoint retrieves a list of all restore points of EFS file systems available in Veeam Backup for AWS.

SecurityBearer
Request
query Parameters
EfsId
string <uuid>

Returns only restore points of an EFS file system with the specified ID.

RestorePointAwsAccountId
string

Returns only EFS restore points stored in an AWS account with the specified ID.

ResourceAwsAccountId
string

Returns only restore points of an EFS file system that belong to an AWS account with the specified ID.

ResourceAwsOrganizationId
string

Returns only EFS restore points of an file system that belong to an AWS Organization with the specified ID.

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 (EfsRestorePointSortColumns)

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: "sizeAsc" "sizeDesc" "jobTypeAsc" "jobTypeDesc" "creationTimeUtcAsc" "creationTimeUtcDesc" "immutableTillUtcAsc" "immutableTillUtcDesc" "restorePointAwsAccountIdAsc" "restorePointAwsAccountIdDesc"
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/restorePoints
Request samples 
curl -i -X GET \
  'https://helpcenter.veeam.com/api/v1/efs/restorePoints?EfsId=497f6eca-6276-4993-bfeb-53cbbbba6f08&RestorePointAwsAccountId=string&ResourceAwsAccountId=string&ResourceAwsOrganizationId=string&Offset=0&Limit=-1&Sort=sizeAsc' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'x-api-version: 1.7-rev0'
Response samples
{
  • "results": [
    ],
  • "totalCount": 0,
  • "_links": [
    ]
}

Get EFS Restore Point Data

The HTTP GET request to the /efs/restorePoints/{restorePointId} endpoint retrieves information on a restore point with the specified ID.

SecurityBearer
Request
path Parameters
restorePointId
required
string <uuid>

Specifies the system ID assigned to a restore point 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).

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/restorePoints/{restorePointId}
Request samples 
curl -i -X GET \
  'https://helpcenter.veeam.com/api/v1/efs/restorePoints/{restorePointId}' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'x-api-version: 1.7-rev0'
Response samples
{
  • "policyName": "string",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "efsId": "56b6f6d4-0389-456b-9e0a-1f661bf39b41",
  • "backupId": "eb7cea43-10b2-42dd-8819-ab9aed37565f",
  • "vpcId": "string",
  • "regionName": "string",
  • "regionDisplayName": "string",
  • "availabilityZoneId": "e8af458c-4211-47cc-becb-5eb05af68c0d",
  • "availabilityZoneName": "string",
  • "jobType": "AwsBackup",
  • "hasManualBackup": true,
  • "hasIndex": true,
  • "createTimeUtc": "2019-08-24T14:15:22Z",
  • "completedTimeUtc": "2019-08-24T14:15:22Z",
  • "status": "string",
  • "kmsKeyId": "string",
  • "size": 0,
  • "performanceMode": "Unknown",
  • "provisionedThroughputInMibps": 0,
  • "mountTargets": [
    ],
  • "accessPoints": [
    ],
  • "immutabilityInfo": {
    },
  • "resourceAwsAccountId": "string",
  • "restorePointAwsAccountId": "string",
  • "_links": [
    ]
}

Remove EFS Restore Point

The HTTP DELETE request to the /efs/restorePoints/{restorePointId} endpoint deletes a restore point created manually.

SecurityBearer
Request
path Parameters
restorePointId
required
string <uuid>

Specifies the system ID assigned to a restore point 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

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

delete/api/v1/efs/restorePoints/{restorePointId}
Request samples 
curl -i -X DELETE \
  'https://helpcenter.veeam.com/api/v1/efs/restorePoints/{restorePointId}' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'x-api-version: 1.7-rev0'
Response samples
{}

Perform Entire File System Restore

The HTTP POST request to the /efs/restorePoints/{restorePointId}/restore endpoint performs restore of an entire EFS file system to a restore point with the specified ID.

SecurityBearer
Request
path Parameters
restorePointId
required
string <uuid>

Specifies the system ID assigned to a restore point 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: application/json
required
restoreToOriginal
required
boolean

Defines whether to restore the file system to the original location.

required
object (AuthenticationSpecification)

Specifies authentication settings used to perform the restore operation.

object (EfsRestoreEntireToDifferentSpecification)

[Applies if you restore the file system to a new location, or with different settings] Specifies settings for the restored file sytem.

reason
string

Specifies a reason for the restore operation.

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/restorePoints/{restorePointId}/restore
Request samples
application/json
{
  • "restoreToOriginal": true,
  • "authenticationSpecification": {
    },
  • "differentLocationSpecification": {
    },
  • "reason": "string"
}
Response samples
{}

Perform Restore of Specific Files

The HTTP POST request to the /efs/restorePoints/{restorePointId}/restoreFiles endpoint performs restore of files and folders of a file system using the specified paths.

SecurityBearer
Request
path Parameters
restorePointId
required
string <uuid>

Specifies the system ID assigned to a restore point 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: application/json
required
restoreToOriginal
required
boolean

Defines whether to restore files to the original location.

required
object (AuthenticationSpecification)

Specifies authentication settings used to perform the restore operation.

itemRestoreCollection
required
Array of strings [ 1 .. 5 ] characters unique

Specifies paths to the files that must be restored. Note:The specified paths must be related to the mount point of the file system. For example, if the file system is mounted to the /user/mydocs/efs point and the file path is /user/mydocs/efs/file1, specify /file1.

object (EfsRestoreFilesToDifferentSpecification)

Specifies settings used to restore files to a new location.

reason
string

Specifies a reason for the restore operation.

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/restorePoints/{restorePointId}/restoreFiles
Request samples
application/json
{
  • "authenticationSpecification": {
    },
  • "restoreToOriginal": true,
  • "differentLocationSpecification": {
    },
  • "itemRestoreCollection": [
    ],
  • "reason": "string"
}
Response samples
{}

Perform EFS File-Level Restore

The HTTP POST request to the /api/v1/efs/restorePoints/{restorePointId}/startFlr endpoint starts a FLR session to restore files and folders of a file system to a restore point with the specified ID.

SecurityBearer
Request
path Parameters
restorePointId
required
string <uuid>

Specifies the system ID assigned to a restore point 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: application/json
required
restoreToOriginal
required
boolean

Defines whether to restore the file system to the original location.

required
object (AuthenticationSpecification)

Specifies authentication settings used to perform the restore operation.

object (StartEfsFlrToDifferentOptions)

Specifies settings used to perform file-level restore.

reason
string

Specifies a reason for the restore operation.

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/restorePoints/{restorePointId}/startFlr
Request samples
application/json
{
  • "restoreToOriginal": true,
  • "authenticationSpecification": {
    },
  • "differentLocationSpecification": {
    },
  • "reason": "string"
}
Response samples
{
  • "sessionId": "cb7b83bc-ca21-40a0-8d67-c57b34498785"
}