This is an archive version of the document. To get the most up-to-date information, see the current version.

Worker Instance Settings

The /settings resource collection represents worker instance settings configured in Veeam Backup for AWS.

Collection URL

The resource collection is located at the following URL:

For IAM role Veeam Backup for AWS uses to launch worker instances

https://<hostname>:<port>/api/v1/settings/serviceAccount

For network settings for AWS regions in which worker instances are launched

https://<hostname>:<port>/api/v1/settings/regions

Worker Instance Settings Collection Representation [for IAM role used to launch worker instances]

{

"serviceAmazonAccountRegionType": "Global",

"serviceAmazonAccountId": "d98f4d37-7874-4be1-9702-770078f5c9cd",

"serviceAmazonAccountName": "Default Backup Restore",

"serviceRegion": "us-east-1",

"_links": [

{

"method": "GET",

"rel": "self",

"href": "https://135.169.170.192:11005/api/v1/settings/serviceAccount"

{

"method": "PUT",

"rel": "update",

"href": "https://135.169.170.192:11005/api/v1/settings/serviceAccount"

}

]

}

Worker Instance Settings Collection Representation [for network settings for AWS regions]

{

"totalCount": 6,

"results": [

{

"regionId": "2cb66942-7feb-4feb-a377-7589adb4e972",

"regionName": "eu-central-1a",

"parentReiognId": "b7ec414c-dff8-467a-8dd9-fa52e5d684f8",

"parentRegionName": "EU (Frankfurt) (eu-central-1)",

"cloudNetworkId": "vpc-66a3c80e",

"cloudNetworkName": "Default (172.31.0.0/16)",

"cloudSubnetworkId": "subnet-32ccfd5a",

"cloudSubnetworkName": "172.31.16.0/20 (eu-central-1a)",

"cloudSecurityGroupId": "sg-056f236c9d4e788a7",

"cloudSecurityGroupName": "Veeam Generic Access",

"_links": [

{

"method": "GET",

"rel": "self",

"href": "https://135.169.170.192:11005/api/v1/settings/regions/2cb66942-7feb-4feb-a377-7589adb4e972"

{

"method": "PUT",

"rel": "update",

"href": "https://135.169.170.192:11005/api/v1/settings/regions/2cb66942-7feb-4feb-a377-7589adb4e972"

{

"method": "DELETE",

"rel": "delete",

"href": "https://135.169.170.192:11005/api/v1/settings/regions/2cb66942-7feb-4feb-a377-7589adb4e972"

}

]

...

"_links": [

{

"method": "GET",

"rel": "self",

"href": "https://135.169.170.192:11005/api/v1/settings/regions"

}

]

}

In This Section