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

Workers

The /workers collection represents worker configurations and profiles added to Veeam Backup for AWS.

Get Collection of Worker Profiles

The HTTP GET request to the /workers/profiles endpoint retrieves a list of all worker profiles added to Veeam Backup for AWS.

x-veeam-authorize: {"roles":["Portal Administrator"]}
SecurityBearer
Request
query Parameters
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.

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/workers/profiles
Request samples 
Response samples 
{}
Add Worker Profiles
The HTTP POST request to the /workers/profiles endpoint creates a new set of worker profiles.


x-veeam-authorize:  {"roles":["Portal Administrator"]}
SecurityBearer 
Request 
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
regionId
required
string <uuid> 
Specifies the system ID assigned in the Veeam Backup for AWS REST API to an AWS Region for which a set of worker profiles will be added.


 
smallProfile
required
string
Specifies an instance type that will be used to launch worker instances if the processed EBS volume size is less than 1024 GB.


 
mediumProfile
required
string
Specifies an instance type that will be used to launch worker instances if the processed EBS volume size is between 1024 GB and 1250 GB.


 
largeProfile
required
string
Specifies an instance type that will be used to launch worker instances if the processed EBS volume size is more than 1250 GB.


 
archiveProfile
required
string
Specifies an instance type that will be used to launch worker instances for transferring data to archive repositories.


 
Responses 
201
Created


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.


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/workers/profiles
Request samples 
application/json
{
  • "regionId": "a29f01e1-8a8d-451e-b685-f8b0b4ec4767",
  • "smallProfile": "string",
  • "mediumProfile": "string",
  • "largeProfile": "string",
  • "archiveProfile": "string"
}
Response samples 
{}
Get Worker Profiles for Region
The HTTP GET request to the /workers/profiles/{regionId} endpoint retrieves information on a set of worker profiles added for a region with the specified ID.


x-veeam-authorize:  {"roles":["Portal Administrator"]}
SecurityBearer 
Request 
path Parameters
regionId
required
string <uuid> 
Specifies the system ID assigned in the Veeam Backup for AWS REST API to a region for which the set of profiles is added.


 
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/workers/profiles/{regionId}
Request samples 
Response samples 
{}
Modify Worker Profiles
The HTTP PUT request to the /workers/profiles/{regionId} endpoint updates a set of worker profiles for a region with the specified ID.


x-veeam-authorize:  {"roles":["Portal Administrator"]}
SecurityBearer 
Request 
path Parameters
regionId
required
string <uuid> 
Specifies a system ID assigned in the Veeam Backup for AWS REST API to a region for which the set of profiles is added.


 
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
smallProfile
required
string
Specifies an instance type that will be used to launch worker instances if the processed EBS volume size is less than 1024 GB.


 
mediumProfile
required
string
Specifies an instance type that will be used to launch worker instances if the processed EBS volume size is between 1024 GB and 1250 GB.


 
largeProfile
required
string
Specifies an instance type that will be used to launch worker instances if the processed EBS volume size is more than 1250 GB.


 
archiveProfile
required
string
Specifies an instance type that will be used to launch worker instances for transferring data to archive repositories.


 
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.


put/api/v1/workers/profiles/{regionId}
Request samples 
application/json
{
  • "smallProfile": "string",
  • "mediumProfile": "string",
  • "largeProfile": "string",
  • "archiveProfile": "string"
}
Response samples 
{}
Remove Worker Profiles
The HTTP DELETE request to the /workers/profiles/{regionId} endpoint removes a set of worker profiles for a region with the specified ID.


x-veeam-authorize:  {"roles":["Portal Administrator"]}
SecurityBearer 
Request 
path Parameters
regionId
required
string <uuid> 
Specifies the system ID assigned in the Veeam Backup for AWS REST API to a region for which the set of profiles is added.


 
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 
204
No Content


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.


delete/api/v1/workers/profiles/{regionId}
Request samples 
Response samples 
{ }
Get IAM Role Used to Launch Worker Instances
The HTTP GET request to the /workers/networkConfiguration/IAMRole endpoint retrieves an IAM role used by Veeam Backup for AWS to launch worker instances.
 
NOTE 
 By default, Veeam Backup for AWS uses the Default Backup Restore IAM role to  launch worker instances. The role is preconfigured and has necessary permissions to launch worker instances within the initial AWS account.


x-veeam-authorize:  {"roles":["Portal Administrator"]}
SecurityBearer 
Request 
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).


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/workers/networkConfiguration/IAMRole
Request samples 
Response samples 
{}
Change IAM Role Used to Launch Worker Instances
The HTTP PUT request to the /workers/networkConfiguration/IAMRole endpoint changes an IAM role used by Veeam Backup for AWS to launch worker instances.
 
NOTE 
 If you change the IAM role used to launch worker instances, all worker configurations added for the backup account will be lost.


x-veeam-authorize:  {"roles":["Portal Administrator"]}
SecurityBearer 
Request 
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
serviceIAMRoleId
required
string <uuid> 
System ID assigned in the Veeam Backup for AWS REST API to an IAM role used to launch worker instances.


 
serviceIAMRoleName
string
Name of the IAM role in Veeam Backup for AWS.


 
serviceIAMRoleRegionType
string (RegionTypes) 
Region type of the AWS account.


 Enum: "Global" "Emulator" "Government" "China"  
serviceRegion
string
AWS Region where the Veeam Backup for AWS appliance resides.


 
Array of objects (Link) 
A list of methods and operations available to the /workers/networkConfiguration/IAMRole collection  in the Veeam Backup for AWS REST API, and request URLs used to perform the operations.


 
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.


put/api/v1/workers/networkConfiguration/IAMRole
Request samples 
application/json
{
  • "serviceIAMRoleId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}
Response samples 
{}
Get Collection of Worker Configurations
The HTTP GET request to the /workers/networkConfiguration endpoint retrieves a list of all worker configurations added for the backup account in Veeam Backup for AWS.


x-veeam-authorize:  {"roles":["Portal Administrator"]}
SecurityBearer 
Request 
query Parameters
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.


 
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/workers/networkConfiguration
Request samples 
Response samples 
{}
Add Worker Configuration
The HTTP POST request to the /workers/networkConfiguration endpoint creates a new worker configuration used to launch worker instances in a specific Availability Zone of an AWS Region.


x-veeam-authorize:  {"roles":["Portal Administrator"]}
SecurityBearer 
Request 
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
availableZoneId
required
string <uuid> 
Specifies the system ID assigned in the Veeam Backup for AWS REST API to an Availability Zone of an AWS Region where worker instances will be launched.


 
cloudNetworkId
required
string
Specifies an AWS ID of an Amazon VPC to which the worker instances will be connected.


 
cloudSubnetworkId
required
string
Specifies the AWS ID of a subnet to which the worker instances will be connected.


 
cloudSecurityGroupId
required
string
Specifies the AWS ID of a security group that must be associated with worker instances.


 
Responses 
201
Created


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.


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/workers/networkConfiguration
Request samples 
application/json
{
  • "availableZoneId": "f27b37dd-e243-42c3-a4ec-8b2ba3988a3d",
  • "cloudNetworkId": "vpc-f3e40a9a",
  • "cloudSubnetworkId": "subnet-00a48d4a",
  • "cloudSecurityGroupId": "sg-a39e55ca"
}
Response samples 
{
  • "availabilityZoneId": "e8af458c-4211-47cc-becb-5eb05af68c0d",
  • "availabilityZoneName": "string",
  • "regionId": "a29f01e1-8a8d-451e-b685-f8b0b4ec4767",
  • "regionName": "string",
  • "cloudNetworkId": "string",
  • "cloudNetworkName": "string",
  • "cloudSubnetworkId": "string",
  • "cloudSubnetworkName": "string",
  • "cloudSecurityGroupId": "string",
  • "cloudSecurityGroupName": "string",
  • "_links": [
    ]
}
Get Worker Configuration Data
The HTTP GET request to the /workers/networkConfiguration/{availabilityZoneId} endpoint retrieves information on a worker configuration created for an Availability Zone with the specified ID.


x-veeam-authorize:  {"roles":["Portal Administrator"]}
SecurityBearer 
Request 
path Parameters
availabilityZoneId
required
string <uuid> 
Specifies the system ID assigned in the Veeam Backup for AWS REST API to an Availability Zone for which the worker configuration is added.


 
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/workers/networkConfiguration/{availabilityZoneId}
Request samples 
Response samples 
{}
Modify Worker Configuration
The HTTP PUT request to the /workers/networkConfiguration/{availabilityZoneId} endpoint updates worker configuration settings for an availability zone with the specified ID.


x-veeam-authorize:  {"roles":["Portal Administrator"]}
SecurityBearer 
Request 
path Parameters
availabilityZoneId
required
string <uuid> 
Specifies the system ID assigned in the Veeam Backup for AWS REST API to an Availability Zone for which the worker configuration is added.


 
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
cloudNetworkId
required
string
Specifies the AWS ID of an Amazon VPC to which the worker instances will be connected.


 
cloudSubnetworkId
required
string
Specifies the AWS ID of a subnet to which the worker instances will be connected.


 
cloudSecurityGroupId
required
string
Specifies the AWS ID of a security group that must be associated with worker instances.


 
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.


put/api/v1/workers/networkConfiguration/{availabilityZoneId}
Request samples 
application/json
{
  • "cloudNetworkId": "string",
  • "cloudSubnetworkId": "string",
  • "cloudSecurityGroupId": "string"
}
Response samples 
{
  • "availabilityZoneId": "e8af458c-4211-47cc-becb-5eb05af68c0d",
  • "availabilityZoneName": "string",
  • "regionId": "a29f01e1-8a8d-451e-b685-f8b0b4ec4767",
  • "regionName": "string",
  • "cloudNetworkId": "string",
  • "cloudNetworkName": "string",
  • "cloudSubnetworkId": "string",
  • "cloudSubnetworkName": "string",
  • "cloudSecurityGroupId": "string",
  • "cloudSecurityGroupName": "string",
  • "_links": [
    ]
}
Remove Worker Configuration
The HTTP DELETE request to the /workers/networkConfiguration/{availabilityZoneId} endpoint removes a worker configuration for an availability zone with the specified ID.


x-veeam-authorize:  {"roles":["Portal Administrator"]}
SecurityBearer 
Request 
path Parameters
availabilityZoneId
required
string <uuid> 
Specifies the system ID assigned in the Veeam Backup for AWS REST API to an Availability Zone for which the worker configuration is added.


 
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 
204
No Content


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.


delete/api/v1/workers/networkConfiguration/{availabilityZoneId}
Request samples 
Response samples 
{ }
Get Worker Configurations for Production Accounts
The HTTP GET request to the /workers/networkConfiguration/production endpoint retrieves a list of worker configurations added for production accounts in Veeam Backup for AWS, and used to launch worker instances that process EFS indexing operations."


x-veeam-authorize:  {"roles":["Portal Administrator"]}
SecurityBearer 
Request 
query Parameters
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.


 
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/workers/networkConfiguration/production
Request samples 
Response samples 
{
  • "totalCount": 0,
  • "results": [
    ],
  • "_links": [
    ]
}
Add Worker Configuration for Production Account
The HTTP POST request to the /workers/networkConfiguration/production endpoint creates a new worker configuration for a specific production account.


x-veeam-authorize:  {"roles":["Portal Administrator"]}
SecurityBearer 
Request 
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
awsAccountId
required
string
Specifies the AWS ID of an AWS account in which worker instances will be launched.


 
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 list region network settings.


 
availableZoneId
required
string <uuid> 
Specifies the system ID assigned in the Veeam Backup for AWS REST API to an Availability Zone for which the configuration will be added.


 
cloudNetworkId
required
string
Specifies the AWS ID of an Amazon VPC to which worker instances will be connected.


 
cloudSubnetworkId
required
string
Specifies the AWS ID of a subnet to which worker instances will be connected.


 
cloudSecurityGroupId
required
string
Specifies the AWS ID of a security group that must be associated with worker instances.


 
Responses 
201
Created


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.


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/workers/networkConfiguration/production
Request samples 
application/json
{
  • "awsAccountId": "string",
  • "IAMRoleId": "31d997b7-510e-4a2c-a173-a131e417c339",
  • "availableZoneId": "949743b4-cfbe-4ca0-84d8-2cafcb53cfe4",
  • "cloudNetworkId": "string",
  • "cloudSubnetworkId": "string",
  • "cloudSecurityGroupId": "string"
}
Response samples 
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "awsAccountId": "string",
  • "IAMRoleId": "31d997b7-510e-4a2c-a173-a131e417c339",
  • "availabilityZoneId": "e8af458c-4211-47cc-becb-5eb05af68c0d",
  • "availabilityZoneName": "string",
  • "regionId": "a29f01e1-8a8d-451e-b685-f8b0b4ec4767",
  • "regionName": "string",
  • "cloudNetworkId": "string",
  • "cloudNetworkName": "string",
  • "cloudSubnetworkId": "string",
  • "cloudSubnetworkName": "string",
  • "cloudSecurityGroupId": "string",
  • "cloudSecurityGroupName": "string",
  • "_links": [
    ]
}
Get Worker Configuration for Production Account Data
The HTTP GET request to the /workers/networkConfiguration/production/{configurationId} endpoint retrieves information on a specific worker configuration created for a production account.


x-veeam-authorize:  {"roles":["Portal Administrator"]}
SecurityBearer 
Request 
path Parameters
configurationId
required
string <uuid> 
Specifies the system ID assigned to a worker configuration 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/workers/networkConfiguration/production/{configurationId}
Request samples 
Response samples 
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "awsAccountId": "string",
  • "IAMRoleId": "31d997b7-510e-4a2c-a173-a131e417c339",
  • "availabilityZoneId": "e8af458c-4211-47cc-becb-5eb05af68c0d",
  • "availabilityZoneName": "string",
  • "regionId": "a29f01e1-8a8d-451e-b685-f8b0b4ec4767",
  • "regionName": "string",
  • "cloudNetworkId": "string",
  • "cloudNetworkName": "string",
  • "cloudSubnetworkId": "string",
  • "cloudSubnetworkName": "string",
  • "cloudSecurityGroupId": "string",
  • "cloudSecurityGroupName": "string",
  • "_links": [
    ]
}
Modify Worker Configuration for Production Account
The HTTP PUT request to the /workers/networkConfiguration/production/{configurationId} endpoint updates settings of a specific worker configuration added for a production account.


x-veeam-authorize:  {"roles":["Portal Administrator"]}
SecurityBearer 
Request 
path Parameters
configurationId
required
string <uuid> 
Specifies the system ID assigned to a worker configuration 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
awsAccountId
required
string
Specifies the AWS ID of an AWS account in which worker instances will be launched.


 
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 list region network settings.


 
availableZoneId
required
string <uuid> 
Specifies the system ID assigned in the Veeam Backup for AWS REST API to an Availability Zone for which the configuration will be added.


 
cloudNetworkId
required
string
Specifies the AWS ID of an Amazon VPC to which worker instances will be connected.


 
cloudSubnetworkId
required
string
Specifies the AWS ID of a subnet to which worker instances will be connected.


 
cloudSecurityGroupId
required
string
Specifies the AWS ID of a security group that must be associated with worker instances.


 
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.


put/api/v1/workers/networkConfiguration/production/{configurationId}
Request samples 
application/json
{
  • "awsAccountId": "string",
  • "IAMRoleId": "31d997b7-510e-4a2c-a173-a131e417c339",
  • "availableZoneId": "949743b4-cfbe-4ca0-84d8-2cafcb53cfe4",
  • "cloudNetworkId": "string",
  • "cloudSubnetworkId": "string",
  • "cloudSecurityGroupId": "string"
}
Response samples 
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "awsAccountId": "string",
  • "IAMRoleId": "31d997b7-510e-4a2c-a173-a131e417c339",
  • "availabilityZoneId": "e8af458c-4211-47cc-becb-5eb05af68c0d",
  • "availabilityZoneName": "string",
  • "regionId": "a29f01e1-8a8d-451e-b685-f8b0b4ec4767",
  • "regionName": "string",
  • "cloudNetworkId": "string",
  • "cloudNetworkName": "string",
  • "cloudSubnetworkId": "string",
  • "cloudSubnetworkName": "string",
  • "cloudSecurityGroupId": "string",
  • "cloudSecurityGroupName": "string",
  • "_links": [
    ]
}
Remove Worker Configuration for Production Account
The HTTP DELETE request to the /workers/networkConfiguration/production/{configurationId} endpoint removes a specific worker configuration added for a production account.


x-veeam-authorize:  {"roles":["Portal Administrator"]}
SecurityBearer 
Request 
path Parameters
configurationId
required
string <uuid> 
Specifies the system ID assigned to a worker configuration 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 
204
No Content


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.


delete/api/v1/workers/networkConfiguration/production/{configurationId}
Request samples 
Response samples 
{ }
Get Worker Custom Tags
The HTTP GET request to the /workers/customTags endpoint retieves a list of all custom tags that are assigned to worker instances.


x-veeam-authorize:  {"roles":["Portal Administrator"]}
SecurityBearer 
Request 
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/workers/customTags
Request samples 
Response samples 
application/json
{
  • "tags": [
    ]
}
Modify Worker Custom Tags
The HTTP PUT request to the /workers/customTags endpoint updates a list of custom tags that must be assigned to worker instances. 
 
NOTE 
 When you update worker tags, custom tags previously assigned to worker instances are replaced with the tags sent in the request. 


x-veeam-authorize:  {"roles":["Portal Administrator"]}
SecurityBearer 
Request 
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
required
Array of objects (TagSpec) 
Specifies AWS tags that must be assigned to worker instances.


 
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.


500
Internal Server Error. The request has been received but could not be completed because of an internal error at the server side.


put/api/v1/workers/customTags
Request samples 
application/json
{
  • "tags": [
    ]
}
Response samples 
application/json
{
  • "tags": [
    ]
}