Veeam Backup for AWS 9
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.

ResourceAwsAccountId
string

Returns RDS restore points of an DB instance that belong to an AWS account with the specified ID.

ResourceAwsOrganizationId
string

Returns RDS restore points of a DB instance that belong to an AWS Organization 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 (RdsRestorePointSortColumns)

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.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/rds/restorePoints
Request samples 
curl -i -X GET \
  'https://helpcenter.veeam.com/api/v1/rds/restorePoints?RdsId=497f6eca-6276-4993-bfeb-53cbbbba6f08&RestorePointAwsAccountId=string&ResourceAwsAccountId=string&ResourceAwsOrganizationId=string&SearchPattern=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 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.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/rds/restorePoints/{restorePointId}
Request samples 
curl -i -X GET \
  'https://helpcenter.veeam.com/api/v1/rds/restorePoints/{restorePointId}' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'x-api-version: 1.7-rev0'
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",
  • "restorePointAwsAccountId": "string",
  • "_links": [
    ]
}

Remove RDS Resource Restore Point

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

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

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

Request Body schema: application/json
required
required
object (AuthenticationSpecification)

Specifies authentication settings used to perform the restore operation.

restoreToOriginal
required
boolean

Defines whether to restore the RDS resource to the original location.

object (RdsRestoreToDifferentSpec)

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

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

Perform DB Instance Database Restore

The HTTP POST request to the /rds/restorePoints/{restorePointId}/restoreBackup endpoint performs database recovery of a PostgreSQL DB instance 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 a PostgreSQL DB instance 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
required
object (AuthenticationSpecification)

Specifies authentication settings used to perform the restore operation.

required
object (RdsRestoreToDifferentSpec)

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

reason
string

Specifies a reason for the restore operation.

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

503

Service Unavailable

504

Gateway Timeout

post/api/v1/rds/restorePoints/{restorePointId}/restoreBackup
Request samples
application/json
{
  • "authenticationSpecification": {
    },
  • "reason": "string",
  • "restoreToDifferentSpec": {
    },
  • "restoreBackupSpec": {
    }
}
Response samples
{}

Validate the RDS Resource Restore from Backup

The HTTP POST request to the /rds/restorePoints/{restorePointId}/validateRestoreBackup endpoint checks whether the restore settings specified for the restore operation of the PostgreSQL DB instance from an image-level are valid.

SecurityBearer
Request
path Parameters
restorePointId
required
string <uuid>

Specifies the system ID assigned to the restore point of a PostgreSQL DB instance 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
required
object (AuthenticationSpecification)

Specifies authentication settings used to perform the restore operation.

required
object (RdsRestoreToDifferentSpec)

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

reason
string

Specifies a reason for the restore operation.

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

503

Service Unavailable

504

Gateway Timeout

post/api/v1/rds/restorePoints/{restorePointId}/validateRestoreBackup
Request samples
application/json
{
  • "authenticationSpecification": {
    },
  • "reason": "string",
  • "restoreToDifferentSpec": {
    },
  • "restoreBackupSpec": {
    }
}
Response samples
{
  • "validationDetails": "string",
  • "help": "string",
  • "result": "Info",
  • "problemType": "Network"
}

Validate RDS Resource Restore from Snapshot

The HTTP POST request to the /rds/restorePoints/{restorePointId}/validateRestore endpoint checks whether the restore settings specified for the restore operation of the RDS resource from a cloud-native snapshot are valid.

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

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

Request Body schema: application/json
required
required
object (AuthenticationSpecification)

Specifies authentication settings used to perform the restore operation.

restoreToOriginal
required
boolean

Defines whether to restore the RDS resource to the original location.

object (RdsRestoreToDifferentSpec)

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

reason
string

Specifies a reason for the restore operation.

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

post/api/v1/rds/restorePoints/{restorePointId}/validateRestore
Request samples
application/json
{
  • "authenticationSpecification": {
    },
  • "restoreToOriginal": true,
  • "restoreToDifferentSpec": {
    },
  • "reason": "string"
}
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.

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.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/rds/restorePoints/{restorePointId}/databases
Request samples 
curl -i -X GET \
  'https://helpcenter.veeam.com/api/v1/rds/restorePoints/{restorePointId}/databases' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'x-api-version: 1.7-rev0'
Response samples
No sample