Veeam Backup for AWS 9 [Archived]
REST API Reference
Related documents

RDS Restore Points

The /rds/restorePoints resource collection represents all restore points created for RDS resources and available in Veeam Backup for AWS.

Get RDS Resource Restore Points

The HTTP GET request to the /rds/restorePoints endpoint retrieves a list of all restore points of RDS resources available in Veeam Backup for AWS.

SecurityBearer
Request
query Parameters
RdsId
string <uuid>

Returns only restore points of an RDS resource with the specified ID.

RestorePointAwsAccountId
string

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

SearchPattern
string

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

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

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" "regionNameAsc" "regionNameDesc" "immutableTillUtcAsc" "immutableTillUtcDesc" "restorePointAwsAccountIdAsc" "restorePointAwsAccountIdDesc"
header Parameters
x-api-version
required
string
Default: 1.6-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 at the server side.

get/api/v1/rds/restorePoints
Request samples 
Response samples 
{
  • "results": [
    ],
  • "totalCount": 0,
  • "_links": [
    ]
}
Get RDS Resource Restore Point Data
The HTTP GET request to the /rds/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 the restore point of an RDS resource in the Veeam Backup for AWS REST API.


 
header Parameters
x-api-version
required
string
 Default:  1.6-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 at the server side.


get/api/v1/rds/restorePoints/{restorePointId}
Request samples 
Response samples 
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "rdsId": "7c032737-d288-4a16-95dd-d697863b2f07",
  • "jobType": "Snapshot",
  • "multiAz": true,
  • "engine": "mariadb",
  • "engineVersion": "string",
  • "policyName": "string",
  • "snapshotIdentifier": "string",
  • "snapshotType": "string",
  • "port": 0,
  • "storageType": "string",
  • "iops": 0,
  • "endpoint": "string",
  • "license": "string",
  • "instanceClass": "string",
  • "subnetGroup": "string",
  • "optionsGroup": "string",
  • "parametersGroup": "string",
  • "securityGroups": [
    ],
  • "createTimeUtc": "2019-08-24T14:15:22Z",
  • "regionName": "string",
  • "regionDisplayName": "string",
  • "encryptionKey": "string",
  • "autoMinorVersionUpgrade": true,
  • "copyTagsToSnapshot": true,
  • "publiclyAccessible": true,
  • "IAMDatabaseAuthenticationEnabled": true,
  • "deletionProtection": true,
  • "auroraClusterDetails": {
    },
  • "immutabilityInfo": {
    },
  • "resourceAwsAccountId": "string",
  • "_links": [
    ]
}
Remove RDS Resource Restore Point
The HTTP DELETE request to the /rds/restorePoints/{restorePointId} endpoint deletes a restore point with the specified ID.


x-veeam-authorize:  {"roles":["Portal Administrator","Portal Operator"]}
SecurityBearer 
Request 
path Parameters
restorePointId
required
string <uuid> 
Specifies the system ID assigned to the restore point of an RDS resource in the Veeam Backup for AWS REST API.


 
header Parameters
x-api-version
required
string
 Default:  1.6-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 at the server side.


delete/api/v1/rds/restorePoints/{restorePointId}
Request samples 
Response samples 
{}
Perform RDS Resource Restore
The HTTP POST request to the /rds/restorePoints/{restorePointId}/restore endpoint performs restore of an RDS resource to a restore point with the specified ID.


SecurityBearer 
Request 
path Parameters
restorePointId
required
string <uuid> 
Specifies the system ID assigned to the restore point of an RDS resource in the Veeam Backup for AWS REST API.


 
header Parameters
x-api-version
required
string
 Default:  1.6-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 an RDS resource to the original location.


 
required
object (AuthenticationSpecification) 
Specifies authentication settings used to perform the restore operation.


 
reason
string
Specifies a reason for the restore operation.


 
object (RdsRestoreToDifferentSpec) 
[Applies if the RDS resource is resored to a new location, or with different settings] Specifies settings for the restored RDS resource.


 
object (RdsRestoreBackupSpec) 
Specifies settings for database restore.


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


post/api/v1/rds/restorePoints/{restorePointId}/restore
Request samples 
application/json
{
  • "restoreToOriginal": true,
  • "authenticationSpecification": {
    },
  • "reason": "string",
  • "restoreToDifferentSpec": {
    },
  • "restoreBackupSpec": {
    }
}
Response samples 
{}
Validate the RDS Resource Restore
The HTTP POST request to the /rds/restorePoints/{restorePointId}/validateRestoreBackup endpoint checks whether the restore operation of an RDS resource from an image-level backup with the specified ID is valid.


x-veeam-authorize:  {"roles":["Portal Administrator"]}
SecurityBearer 
Request 
path Parameters
restorePointId
required
string <uuid> 
Specifies the system ID assigned to the restore point of an RDS resource in the Veeam Backup for AWS REST API.


 
header Parameters
x-api-version
required
string
 Default:  1.6-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 an RDS resource to the original location.


 
required
object (AuthenticationSpecification) 
Specifies authentication settings used to perform the restore operation.


 
reason
string
Specifies a reason for the restore operation.


 
object (RdsRestoreToDifferentSpec) 
[Applies if the RDS resource is resored to a new location, or with different settings] Specifies settings for the restored RDS resource.


 
object (RdsRestoreBackupSpec) 
Specifies settings for database restore.


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


post/api/v1/rds/restorePoints/{restorePointId}/validateRestoreBackup
Request samples 
application/json
{
  • "restoreToOriginal": true,
  • "authenticationSpecification": {
    },
  • "reason": "string",
  • "restoreToDifferentSpec": {
    },
  • "restoreBackupSpec": {
    }
}
Response samples 
{
  • "validationDetails": "string",
  • "help": "string",
  • "result": "Info",
  • "problemType": "Network"
}
Get RDS Resource Restore Point Databases List
The HTTP GET request to the /rds/restorePoints/{restorePointId}/databases endpoint retrieves a list of all RDS databases that are protected by the restore point.


x-veeam-authorize:  {"roles":["Portal Administrator"]}
SecurityBearer 
Request 
path Parameters
restorePointId
required
string <uuid> 
Specifies the system ID assigned to the restore point of an RDS resource in the Veeam Backup for AWS REST API.


 
header Parameters
x-api-version
required
string
 Default:  1.6-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 at the server side.


get/api/v1/rds/restorePoints/{restorePointId}/databases
Request samples 
Response samples 
No sample