RDS Resources

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

Get Collection of RDS Resources

The HTTP GET request to the /rds endpoint retrieves a list of all RDS resources that can be protected by 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 RDS resources that belong to an AWS Account with the specified AWS ID.
ResourceAwsOrganizationId	string Returns only RDS resources that belong to an AWS Organization with the specified AWS ID.
RegionId	string <uuid> Returns only resources 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 (RdsSortColumns) 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" "engineAsc" "engineDesc" "resourceAwsAccountIdAsc" "resourceAwsAccountIdDesc"
EngineType	Array of strings Returns only RDS resources with the specified database engine type. For more information, see the Veeam Backup for AWS REST API Reference Overview, section Filter Parameter. Items Enum: "mariadb" "mysql" "oracle-ee" "oracle-ee-cdb" "oracle-se2" "oracle-se2-cdb" "oracle-se1" "oracle-se" "postgres" "sqlserver-ee" "sqlserver-se" "sqlserver-ex" "sqlserver-web" "aurora" "aurora-mysql" "aurora-postgresql"

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

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

Request samples

curl
Python
JavaScript
C#
Go

curl -i -X GET \
  'https://helpcenter.veeam.com/api/v1/rds?SearchPattern=string&ResourceAwsAccountId=string&ResourceAwsOrganizationId=string&RegionId=497f6eca-6276-4993-bfeb-53cbbbba6f08&Offset=0&Limit=0&Sort=nameAsc&EngineType=mariadb' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'x-api-version: 1.7-rev0'

Response samples

{"results": [{"engine": "mariadb",
"id": "c43ce2cb-a504-4366-a732-7e7d8788cf37",
"awsResourceId": "rdsi-eu-west-2-db-tyfy5sxh7sbrjgpwn4t6xxwazi",
"name": "le-mariadb",
"engineVersion": "10.4.8",
"instanceClass": "db.t2.micro",
"instanceSizeGigabytes": 40,
"instanceDnsName": "le-mariadb.cqznrfj6grdy.eu-west-2.rds.amazonaws.com:3306",
"policiesCount": 0,
"region": {"id": "3875ab9c-bab1-4c46-b107-d834cd4db073",
"name": "eu-west-2"
},
"location": {"id": "bf9a12e8-f607-4d8a-8a0e-579abd724d4a",
"name": "eu-west-2c"
},
"awsAccount": {"id": "d98f4d37-7874-4be1-9702-770078f5c9cd",
"name": "Default Backup Restore"
},
"createTimeUtc": "2020-10-28T13:02:25.958",
"isDeleted": false,
"links": [{"method": "Get",
"rel": "self",
"href": "https://123.123.123.123:11005/api/v1/rds/c43ce2cb-a504-4366-a732-7e7d8788cf37"
},
{"method": "POST",
"rel": "TakeSnapshot",
"href": "https://123.123.123.123:11005/api/v1/rds/c43ce2cb-a504-4366-a732-7e7d8788cf37/takeSnapshot"
},
{"method": "Get",
"rel": "Region",
"href": "https://123.123.123.123:11005/api/v1/cloudInfrastructure/regions/bf9a12e8-f607-4d8a-8a0e-579abd724d4a"
}
]
},
{"engine": "oracle-ee",
"id": "3d10e07a-5c3c-4017-a5c0-37952bada955",
"awsResourceId": "rdsi-eu-north-1-db-mx72k36wtnx6aky323nowi5mky",
"name": "le-oraclesb",
"engineVersion": "19.0.0.0.ru-2020-07.rur-2020-07.r1",
"instanceSizeGigabytes": 20,
"instanceClass": "db.t3.small",
"instanceDnsName": "le-oraclesb.abcdefghijk.eu-north-1.rds.amazonaws.com",
"policiesCount": 1,
"region": {"id": "e3d35913-eb00-47c7-9f45-1d05e6bedcf0",
"name": "eu-north-1"
},
"location": {"id": "152eb515-56b5-45c1-ae56-0de462fb6b37",
"name": "eu-north-1b"
},
"awsAccount": {"id": "d98f4d37-7874-4be1-9702-770078f5c9cd",
"name": "Default Backup Restore"
},
"encryptinKey": "arn:aws:kms:eu-north-1:111111111111:key/7e034548-645f-4f90-9c62-41062801cde4",
"createTimeUtc": "2020-11-13T14:09:06.287",
"isDeleted": false,
"links": [{"method": "Get",
"rel": "self",
"href": "https://123.123.123.123:11005/api/v1/rds/3d10e07a-5c3c-4017-a5c0-37952bada955"
},
{"method": "POST",
"rel": "TakeSnapshot",
"href": "https://123.123.123.123:11005/api/v1/rds/3d10e07a-5c3c-4017-a5c0-37952bada955/takeSnapshot"
},
{"method": "Get",
"rel": "Region",
"href": "https://123.123.123.123:11005/api/v1/cloudInfrastructure/regions/152eb515-56b5-45c1-ae56-0de462fb6b37"
}
]
}
],
"totalCount": 2,
"links": [{"method": "Get",
"rel": "self",
"href": "https://123.123.123.123:11005/api/v1/rds"
}
]
}

Perform Infrastructure Rescan for RDS Resources

The HTTP POST request to the /rds/rescan endpoint runs the infrastructure rescanning operation for RDS resources.

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/rds/rescan

Request samples

curl
Python
JavaScript
C#
Go

curl -i -X POST \
  https://helpcenter.veeam.com/api/v1/rds/rescan \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'x-api-version: 1.7-rev0'

Response samples

{"sessionId": "1b1a25b9-1131-469a-914c-5318b0aa1b07",
"_links": [{"method": "GET",
"rel": "self",
"href": "https://123.123.123.123:11005/api/v1/sessions/1b1a25b9-1131-469a-914c-5318b0aa1b07"
}
]
}

Get RDS Resource Data

The HTTP GET request to the /rds/{rdsId} endpoint retrieves information on an RDS resource with the specified ID.

SecurityBearer

Request

path Parameters

rdsId

required

string <uuid>

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

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/{rdsId}

Request samples

curl
Python
JavaScript
C#
Go

curl -i -X GET \
  'https://helpcenter.veeam.com/api/v1/rds/{rdsId}' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'x-api-version: 1.7-rev0'

Response samples

{"engine": "oracle-ee",
"id": "3d10e07a-5c3c-4017-a5c0-37952bada955",
"awsResourceId": "rdsi-eu-north-1-db-mx72k36wtnx6aky323nowi5mky",
"name": "le-oraclesb",
"engineVersion": "19.0.0.0.ru-2020-07.rur-2020-07.r1",
"instanceSizeGigabytes": 20,
"instanceClass": "db.t3.small",
"instanceDnsName": "le-oraclesb.abcdefghijk.eu-north-1.rds.amazonaws.com",
"policiesCount": 1,
"region": {"id": "e3d35913-eb00-47c7-9f45-1d05e6bedcf0",
"name": "eu-north-1"
},
"location": {"id": "152eb515-56b5-45c1-ae56-0de462fb6b37",
"name": "eu-north-1b"
},
"awsAccount": {"id": "d98f4d37-7874-4be1-9702-770078f5c9cd",
"name": "Default Backup Restore"
},
"encryptinKey": "arn:aws:kms:eu-north-1:111111111111:key/7e034548-645f-4f90-9c62-41062801cde4",
"createTimeUtc": "2020-11-13T14:09:06.287",
"isDeleted": false,
"links": [{"method": "Get",
"rel": "self",
"href": "https://123.123.123.123:11005/api/v1/rds/3d10e07a-5c3c-4017-a5c0-37952bada955"
},
{"method": "POST",
"rel": "TakeSnapshot",
"href": "https://123.123.123.123:11005/api/v1/rds/3d10e07a-5c3c-4017-a5c0-37952bada955/takeSnapshot"
},
{"method": "Get",
"rel": "Region",
"href": "https://123.123.123.123:11005/api/v1/cloudInfrastructure/regions/152eb515-56b5-45c1-ae56-0de462fb6b37"
}
]
}

Create Snapshot of RDS Resource

The HTTP POST request to the /rds/{rdsId}/takeSnapshot endpoint creates a manual snapshot of an RDS resource with the specified ID.

NOTE
When you create a snapshot manually, Veeam Backup for AWS detects if there is a snapshot chain for the processed RDS resource. If the snapshot chain exists, Veeam Backup for AWS continues the existing chain. Otherwise, the created snapshot starts a new snapshot chain for the processed RDS resource.

SecurityBearer

Request

path Parameters

rdsId

required

string <uuid>

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

IAMRoleId required	string <uuid> Specifies an IAM role whose permissions Veeam Backup for AWS will use to create a cloud-native snapshot.
targetIAMRoleIdToCopySnapshots	string <uuid> [Applies to the Remote region snapshot mode] Specifies an IAM role that has permissions to store snapshots in the target AWS Region.
targetRegionIdToCopySnapshots	string <uuid> [Applies to the Remote region snapshot mode] Specifies a target AWS Region to store the created snapshot.
encryptionKey	string [Applies to the Remote region snapshot mode with encryption enabled] Specifies the ARN of a KMS key used for snapshot encryption.
	Array of objects (Tag) [Applies if you want to assign custom tags]
copyTagsFromInstanceEnabled	boolean Defines whether to assign tags of EBS volumes attached to processed EC2 instances. The default value is false.

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/{rdsId}/takeSnapshot

Request samples

application/json

{"IAMRoleId": "eca01dcc-d324-4017-92cb-04ec240aaf0a",
"copyTagsFromVolumeEnabled": true
}

Response samples

{"sessionId": "1b1a25b9-1131-469a-914c-5318b0aa1b07",
"_links": [{"method": "GET",
"rel": "self",
"href": "https://123.123.123.123:11005/api/v1/sessions/1b1a25b9-1131-469a-914c-5318b0aa1b07"
}
]
}

Remove Snapshots of RDS Resource

The HTTP POST request to the /rds/{rdsId}/deleteSnapshots endpoint removes the whole snapshot chain of an RDS resource with the specified ID.

SecurityBearer

Request

path Parameters

rdsId

required

string <uuid>

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

The snapshot removal specification.

snapshotType

string (DeleteSnapshotType)

Specifies the type of snapshots that will be deleted.

Enum: "All" "Standard" "Replica" "Manual"

Responses

202

Accepted

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

post/api/v1/rds/{rdsId}/deleteSnapshots

Request samples

application/json

{"snapshotType": "All"
}

Response samples

{"sessionId": "1b1a25b9-1131-469a-914c-5318b0aa1b07",
"_links": [{"method": "GET",
"rel": "self",
"href": "https://123.123.123.123:11005/api/v1/sessions/1b1a25b9-1131-469a-914c-5318b0aa1b07"
}
]
}

Remove Backups of RDS Resource

The HTTP POST request to the /rds/{rdsId}/deleteBackups endpoint removes the whole backup chain of an RDS resource with the specified ID.

SecurityBearer

Request

path Parameters

rdsId

required

string <uuid>

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

The backup removal specification.

backupType

string (DeleteBackupType)

Specifies the type of backups that will be deleted.

Enum: "All" "Standard" "Archived"

Responses

202

Accepted

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

post/api/v1/rds/{rdsId}/deleteBackups

Request samples

application/json

{"backupType": "All"
}

Response samples

{"sessionId": "1b1a25b9-1131-469a-914c-5318b0aa1b07",
"_links": [{"method": "GET",
"rel": "self",
"href": "https://123.123.123.123:11005/api/v1/sessions/1b1a25b9-1131-469a-914c-5318b0aa1b07"
}
]
}

Remove Restore Points of RDS Resource

The HTTP DELETE request to the /rds/{rdsId}/restorePoints endpoint deletes all restore points of an RDS resource with the specified ID.

SecurityBearer

Request

path Parameters

rdsId

required

string <uuid>

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

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

delete/api/v1/rds/{rdsId}/restorePoints

Request samples

curl
Python
JavaScript
C#
Go

curl -i -X DELETE \
  'https://helpcenter.veeam.com/api/v1/rds/{rdsId}/restorePoints' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'x-api-version: 1.7-rev0'

Response samples

{"sessionId": "1b1a25b9-1131-469a-914c-5318b0aa1b07",
"_links": [{"method": "GET",
"rel": "self",
"href": "https://123.123.123.123:11005/api/v1/sessions/1b1a25b9-1131-469a-914c-5318b0aa1b07"
}
]
}

RDS Resources

Get Collection of RDS Resources

query Parameters

header Parameters

Perform Infrastructure Rescan for RDS Resources

header Parameters

Get RDS Resource Data

path Parameters

header Parameters

Create Snapshot of RDS Resource

path Parameters

header Parameters

Request Body schema: application/jsonrequired

Remove Snapshots of RDS Resource

path Parameters

header Parameters

Request Body schema: application/json

Remove Backups of RDS Resource

path Parameters

header Parameters

Request Body schema: application/json

Remove Restore Points of RDS Resource

path Parameters

header Parameters

Request Body schema: application/json
required