Veeam Backup for AWS 9
REST API Reference
Related documents

FSx Restore Points

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

Get FSx Restore Points

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

SecurityBearer
Request
query Parameters
FsxId
string <uuid>

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

RestorePointAwsAccountId
string

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

ResourceAwsAccountId
string

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

ResourceAwsOrganizationId
string

Returns only restore points of an FSx 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 (FsxRestorePointSortColumns)

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" "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/fsx/restorePoints
Request samples 
curl -i -X GET \
  'https://helpcenter.veeam.com/api/v1/fsx/restorePoints?FsxId=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 FSx Restore Point Data

The HTTP GET request to the /fsx/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/fsx/restorePoints/{restorePointId}
Request samples 
curl -i -X GET \
  'https://helpcenter.veeam.com/api/v1/fsx/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",
  • "name": "string",
  • "fsxId": "bf106c0c-179c-4ede-b72a-fc17a28a40b1",
  • "awsResourceId": "string",
  • "backupId": "eb7cea43-10b2-42dd-8819-ab9aed37565f",
  • "regionName": "string",
  • "regionDisplayName": "string",
  • "jobType": "AwsFsxBackup",
  • "hasManualBackup": true,
  • "createTimeUtc": "2019-08-24T14:15:22Z",
  • "completedTimeUtc": "2019-08-24T14:15:22Z",
  • "status": "string",
  • "isStandalone": true,
  • "type": "Unknown",
  • "deploymentType": "Unknown",
  • "storageType": "Unknown",
  • "storageCapacity": 0,
  • "vpcId": "string",
  • "subnetId": "string",
  • "preferredSubnetId": "string",
  • "routeTableIds": [
    ],
  • "activeDirectorySettings": {
    },
  • "resourceAwsAccountId": "string",
  • "restorePointAwsAccountId": "string",
  • "securityGroupIds": [
    ],
  • "encryptionKey": "string",
  • "_links": [
    ]
}

Remove FSx Restore Point

The HTTP DELETE request to the /fsx/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/fsx/restorePoints/{restorePointId}
Request samples 
curl -i -X DELETE \
  'https://helpcenter.veeam.com/api/v1/fsx/restorePoints/{restorePointId}' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'x-api-version: 1.7-rev0'
Response samples
{}

Perform FSx File System Restore

The HTTP POST request to the /fsx/restorePoints/{restorePointId}/restore endpoint performs restore of an FSx 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 FSx file system to the original location.

required
object (AuthenticationSpecification)

Specifies authentication settings used to perform the restore operation.

object (FsxRestoreToDifferentSpecification)

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

activeDirectoryServiceAccountPassword
string

[Applies only to Windows File Server file systems] Specifies the password of the service account that the restored FSx file system will use to join to self-managed Microsoft AD.

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