Veeam Backup for AWS 9
REST API Reference
Related documents

EFS File Systems

The /efs resource collection represents all file systems that reside in AWS Regions selected in the backup policy settings and can be protected by Veeam Backup for AWS.

Get Collection of EFS File Systems

The HTTP GET request to the /efs endpoint retrieves all EFS file systems available to 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.

ResourceAwsAccountId
string

Returns only EFS file systems that belong to an AWS Account with the specified AWS ID.

ResourceAwsOrganizationId
string

Returns only EFS file systems that belong to an AWS Organization with the specified AWS ID.

RegionId
string <uuid>

Returns only file systems residing in an AWS Region with the specified ID.

Offset
integer <int32>

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

Limit
integer <int32>

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

Sort
Array of strings (EfsSortColumns)

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" "locationAsc" "locationDesc" "resourceAwsAccountIdAsc" "resourceAwsAccountIdDesc"
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
Request samples 
curl -i -X GET \
  'https://helpcenter.veeam.com/api/v1/efs?SearchPattern=string&ResourceAwsAccountId=string&ResourceAwsOrganizationId=string&RegionId=497f6eca-6276-4993-bfeb-53cbbbba6f08&Offset=0&Limit=0&Sort=nameAsc' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'x-api-version: 1.7-rev0'
Response samples
application/json
{
  • "results": [
    ],
  • "totalCount": 0,
  • "_links": [
    ]
}

Perform Infrastructure Rescan for EFS File Systems

The HTTP POST request to the /efs/rescan endpoint runs the infrastructure rescanning operation for EFS file systems.

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

Get EFS File System Data

The HTTP GET request to the /efs/{efsId} endpoint retrieves data on an EFS file system with the specified ID.

SecurityBearer
Request
path Parameters
efsId
required
string <uuid>

System ID assigned to a file system 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/{efsId}
Request samples 
curl -i -X GET \
  'https://helpcenter.veeam.com/api/v1/efs/{efsId}' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'x-api-version: 1.7-rev0'
Response samples
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "isDeleted": true,
  • "awsResourceId": "string",
  • "resourceAwsAccountId": "string",
  • "region": {
    },
  • "IAMRole": {
    },
  • "creationTime": "2019-08-24T14:15:22Z",
  • "encrypted": true,
  • "kmsKeyId": "string",
  • "performanceMode": "Unknown",
  • "throughputMode": "Unknown",
  • "provisionedThroughputInMibps": 0,
  • "size": 0,
  • "_links": [
    ]
}

Create Backup of File System

The HTTP POST request to the /efs/{efsId}/takeBackup endpoint creates a manual backup of an EFS file system with the specified ID.

SecurityBearer
Request
path Parameters
efsId
required
string <uuid>

System ID assigned to a file system 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
IAMRoleId
required
string <uuid>

Specifies the system ID assigned in the Veeam Backup for AWS REST API to an IAM role whose permissions Veeam Backup for AWS will use to access AWS resources and perform file system backup.

targetVaultId
required
string <uuid>

System ID assigned in the Veeam Backup for AWS REST API to a backup vault that will be used to store the backup.

Array of objects (TagSpec)

Specifies custom tags to be assigned to the file system backup.

copyTagsFromVolumeEnabled
boolean

Defines whether to copy tags of he processed file systems and assign them to backups produced by 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/{efsId}/takeBackup
Request samples
application/json
{
  • "IAMRoleId": "31d997b7-510e-4a2c-a173-a131e417c339",
  • "targetVaultId": "f7120e0b-5e2b-4e35-a0c4-9d04ff05e67f",
  • "additionalTags": [
    ],
  • "copyTagsFromVolumeEnabled": true
}
Response samples
{}

Remove Backups of File System

The HTTP POST request to the /efs/{efsId}/deleteBackup endpoint removes backups of an EFS file system with the specified ID.

SecurityBearer
Request
path Parameters
efsId
required
string <uuid>

System ID assigned to a file system 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
destinationTypeToRemove
required
string (EfsBackupTypeToRemove)

Specifies the type of the file system backup that will be removed.

Enum: "All" "Backup" "ManualBackup" "RemoteBackup"
manualBackupRestorePoint
string <uuid>

[Applies if the ManualBackup value was specified for the destinationTypeToRemove parameter] System ID assigned in the Veeam Backup for AWS REST API to the manual backup that will be removed.

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/{efsId}/deleteBackup
Request samples
application/json
{
  • "destinationTypeToRemove": "All",
  • "manualBackupRestorePoint": "14728a19-ade2-4036-988a-bbe9c2ccbbb0"
}
Response samples
{}