Veeam Backup for Google Cloud 7
REST API Reference
Related documents

Workers

The /workers resource collection represents worker configurations and profiles added to Veeam Backup for Google Cloud.

Get Worker Custom Labels

The HTTP GET request to the /workers/customLabels endpoint retrieves a full list of all custom labels assigned to worker instances.

SecurityBearer
Request
header Parameters
x-api-version
required
string
Default: 1.4-rev0

Specifies the current revision of the Veeam Backup for Google Cloud 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.

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/customLabels
Request samples 
Response samples 
application/json
{
  • "labels": [
    ]
}
Modify Worker Custom Labels
The HTTP PUT request to the /workers/customLabels updates custom labels assigned to worker instances. 
 
NOTE When you update worker labels, custom labels previously assigned to worker instances are replaced with the labels sent in the request.


SecurityBearer 
Request 
header Parameters
x-api-version
required
string
 Default:  1.4-rev0
Specifies the current revision of the Veeam Backup for Google Cloud REST API.


 
Request Body schema: application/json
required
Array of objects (TagModel) 
Custom labels 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/customLabels
Request samples 
application/json
{
  • "labels": [
    ]
}
Response samples 
application/json
{
  • "workerLabels": {
    },
  • "issues": [
    ]
}
Get Project Selected for Worker Instances
The HTTP GET request to the /workers/networkConfiguration/project endpoint retrieves a name and an ID of a project where worker instances are created.


SecurityBearer 
Request 
header Parameters
x-api-version
required
string
 Default:  1.4-rev0
Specifies the current revision of the Veeam Backup for Google Cloud 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/project
Request samples 
Response samples 
application/json
{
  • "ProjectId": "string",
  • "ProjectName": "string",
  • "serviceAccountId": "a814cf67-aaac-43ae-acb4-8d34e82a4b4c",
  • "serviceAccountName": "string"
}
Change Project for Worker Instances
The HTTP PUT request to the /workers/networkConfiguration/project endpoint allows you to change a project where worker instances are created. 
 
IMPORTANT 
 If you change the project, all worker configurations related to this project will be removed.


SecurityBearer 
Request 
header Parameters
x-api-version
required
string
 Default:  1.4-rev0
Specifies the current revision of the Veeam Backup for Google Cloud REST API.


 
Request Body schema: application/json
required
projectId
required
string
Specifies the Google Cloud ID assigned to a project.


 
serviceAccountId
required
string <uuid> 
Specifies the system ID assigned in the Veeam Backup for Google Cloud REST API to a service account.


 
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/project
Request samples 
application/json
{
  • "projectId": "string",
  • "serviceAccountId": "a814cf67-aaac-43ae-acb4-8d34e82a4b4c"
}
Response samples 
application/json
{
  • "configuration": {
    },
  • "issues": [
    ]
}
Get Worker Configurations
The HTTP GET request to the /workers/settings retrieves a full list of all worker configurations added to Veeam Backup for Google Cloud.


SecurityBearer 
Request 
query Parameters
filter
string
Returns only specific items of a resource collection in the response. To learn how to use the filter parameter, see the Veeam Backup for Google Cloud REST API Reference, section Filter Parameter.


 
orderby
string
Specifies the order of items in the response. For more information, see the Veeam Backup for Google Cloud REST API Reference Overview, section Orderby Parameter.


 
offset
integer <int32> 
Specifies the first N items of a resource collection that will be excluded from the response.


 
limit
integer <int32> 
Specifies the maximum number of items of a resource collection that will be returned in the response.


 
header Parameters
x-api-version
required
string
 Default:  1.4-rev0
Specifies the current revision of the Veeam Backup for Google Cloud 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.


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/settings
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "pagination": {
    }
}
Add Worker Configuration
The HTTP POST request to the /workers/settings endpoint creates a new worker configuration.


SecurityBearer 
Request 
header Parameters
x-api-version
required
string
 Default:  1.4-rev0
Specifies the current revision of the Veeam Backup for Google Cloud REST API.


 
Request Body schema: application/json
required
networkId
required
string
Specifies the Google Cloud ID of a VPC network to which worker instances will be connected.


 
subnetworkId
required
string
Specifies the Google Cloud ID of a subnet to which worker instances will be connected.


 
firewallRuleId
required
string
Specifies the Google Cloud ID of a firewall rule that will be used to control traffic between resources in the specified VPC network.


 
regionId
string <uuid> 
System ID assigned in the Veeam Backup for Google Cloud REST API to the Google Cloud region where worker instances are launched.


 
zoneId
string <uuid> 
Specifies the system ID assigned in the Veeam Backup for Google Cloud REST API to an availability zone of a Google Cloud region where worker instances will be launched.


 
Array of objects (WorkerCustomLabelItem) 
Specifies the list of custom labels that will 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.


post/api/v1/workers/settings
Request samples 
application/json
{
  • "regionId": "a29f01e1-8a8d-451e-b685-f8b0b4ec4767",
  • "zoneId": "c3920607-5069-4ac3-ba10-00754e7a8e8b",
  • "networkId": "string",
  • "subnetworkId": "string",
  • "firewallRuleId": "string",
  • "workerCustomLabels": [
    ]
}
Response samples 
application/json
{
  • "locationConfiguration": {
    },
  • "issues": [
    ]
}
Get Worker Configuration Data
The HTTP GET request to the /workers/settings/{settingId} endpoint retrieves information on a worker configuration created for a worker setting with the specified ID.


SecurityBearer 
Request 
path Parameters
settingId
required
string <uuid> 
Specifies the system ID assigned in the Veeam Backup for Google Cloud REST API to worker setting.


 
header Parameters
x-api-version
required
string
 Default:  1.4-rev0
Specifies the current revision of the Veeam Backup for Google Cloud 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/settings/{settingId}
Request samples 
Response samples 
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "zoneId": "c3920607-5069-4ac3-ba10-00754e7a8e8b",
  • "zoneName": "string",
  • "regionId": "a29f01e1-8a8d-451e-b685-f8b0b4ec4767",
  • "regionName": "string",
  • "networkId": "string",
  • "networkName": "string",
  • "subnetworkId": "string",
  • "subnetworkName": "string",
  • "firewallRuleId": "string",
  • "firewallRuleName": "string",
  • "workerCustomLabels": [
    ]
}
Modify Worker Configuration
The HTTP PUT request to the /workers/settings/{settingId} endpoint updates worker configuration settings for a worker setting with the specified ID.


SecurityBearer 
Request 
path Parameters
settingId
required
string <uuid> 
Specifies the system ID assigned in the Veeam Backup for Google Cloud REST API to worker setting.


 
header Parameters
x-api-version
required
string
 Default:  1.4-rev0
Specifies the current revision of the Veeam Backup for Google Cloud REST API.


 
Request Body schema: application/json
required
networkId
required
string
Specifies the Google Cloud ID of a VPC network to which worker instances will be connected.


 
subnetworkId
required
string
Specifies the Google Cloud ID of a subnet to which worker instances will be connected.


 
firewallRuleId
required
string
Specifies the Google Cloud ID of a firewall rule that will be used to control traffic between resources in the specified VPC network.


 
regionId
string <uuid> 
System ID assigned in the Veeam Backup for Google Cloud REST API to the Google Cloud region where worker instances are launched.


 
zoneId
string <uuid> 
Specifies the system ID assigned in the Veeam Backup for Google Cloud REST API to an availability zone of a Google Cloud region where worker instances will be launched.


 
Array of objects (WorkerCustomLabelItem) 
Specifies the list of custom labels that will 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.


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/settings/{settingId}
Request samples 
application/json
{
  • "regionId": "a29f01e1-8a8d-451e-b685-f8b0b4ec4767",
  • "zoneId": "c3920607-5069-4ac3-ba10-00754e7a8e8b",
  • "networkId": "string",
  • "subnetworkId": "string",
  • "firewallRuleId": "string",
  • "workerCustomLabels": [
    ]
}
Response samples 
application/json
{
  • "locationConfiguration": {
    },
  • "issues": [
    ]
}
Remove Worker Configuration
The HTTP DELETE request to the /workers/settings/{settingId} endpoint removes a worker configuration for an availability zone with the specified ID.


SecurityBearer 
Request 
path Parameters
settingId
required
string <uuid> 
Specifies the system ID assigned in the Veeam Backup for Google Cloud REST API to worker setting.


 
header Parameters
x-api-version
required
string
 Default:  1.4-rev0
Specifies the current revision of the Veeam Backup for Google Cloud 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/settings/{settingId}
Request samples 
Response samples 
application/json
{ }
Get Worker Profiles
The HTTP GET request to the /workers/profiles retrieves a list of all worker profiles added to Veeam Backup for Google Cloud.


SecurityBearer 
Request 
query Parameters
filter
string
Returns only specific items of a resource collection in the response. To learn how to use the filter parameter, see the Veeam Backup for Google Cloud REST API Reference, section Filter Parameter.


 
orderby
string
Specifies the order of items in the response. For more information, see the Veeam Backup for Google Cloud REST API Reference Overview, section Orderby Parameter.


 
offset
integer <int32> 
Specifies the first N items of a resource collection that will be excluded from the response.


 
limit
integer <int32> 
Specifies the maximum number of items of a resource collection that will be returned in the response.


 
header Parameters
x-api-version
required
string
 Default:  1.4-rev0
Specifies the current revision of the Veeam Backup for Google Cloud 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.


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 
application/json
{
  • "data": [
    ],
  • "pagination": {
    }
}
Add Worker Profiles
The HTTP POST request to the /workers/profiles endpoint creates a new set of worker profiles.


SecurityBearer 
Request 
header Parameters
x-api-version
required
string
 Default:  1.4-rev0
Specifies the current revision of the Veeam Backup for Google Cloud REST API.


 
Request Body schema: application/json
required
regions
required
Array of strings <uuid> 
System IDs assigned in the Veeam Backup for Google Cloud REST API to the regions for which the set of profiles will be added.


 
backupSmall
required
string
Secondary profile used for creating image-level backups if you have run or about to run out of the regional disk quota.


 
backupStandard
required
string
Primary profile used for creating image-level backups if the regional disk quota has not been reached yet.


 
archive
required
string
Archiving profile for creating archive backups.


 
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.


post/api/v1/workers/profiles
Request samples 
application/json
{
  • "regions": [
    ],
  • "backupStandard": "string",
  • "backupSmall": "string",
  • "archive": "string"
}
Response samples 
application/json
{
  • "hardwareConfigurations": [
    ],
  • "issues": [
    ]
}
Get Default Worker Profiles
The HTTP GET request to the /worker/profiles/default endpoint retrieves the default worker profiles used to launch worker instances in Google Cloud regions that have no associated set of profiles in Veeam Backup for Google Cloud.


SecurityBearer 
Request 
header Parameters
x-api-version
required
string
 Default:  1.4-rev0
Specifies the current revision of the Veeam Backup for Google Cloud 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.


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/worker/profiles/default
Request samples 
Response samples 
application/json
{
  • "backupStandard": "string",
  • "backupSmall": "string",
  • "archive": "string"
}
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.


SecurityBearer 
Request 
path Parameters
regionId
required
string <uuid> 
Specifies the system ID assigned in the Veeam Backup for Google Cloud REST API to a region for which the set of profiles is added.


 
header Parameters
x-api-version
required
string
 Default:  1.4-rev0
Specifies the current revision of the Veeam Backup for Google Cloud 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 
application/json
{
  • "regionId": "a29f01e1-8a8d-451e-b685-f8b0b4ec4767",
  • "regionName": "string",
  • "backupStandard": "string",
  • "backupSmall": "string",
  • "archive": "string"
}
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.


SecurityBearer 
Request 
path Parameters
regionId
required
string <uuid> 
Specifies the system ID assigned in the Veeam Backup for Google Cloud REST API to a region for which the set of profiles is added.


 
header Parameters
x-api-version
required
string
 Default:  1.4-rev0
Specifies the current revision of the Veeam Backup for Google Cloud REST API.


 
Request Body schema: application/json
required
backupSmall
required
string
Secondary profile used for creating image-level backups if you have run or about to run out of the regional disk quota.


 
backupStandard
required
string
Primary profile used for creating image-level backups if the regional disk quota has not been reached yet.


 
archive
required
string
Archiving profile for creating archive backups.


 
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
{
  • "backupStandard": "string",
  • "backupSmall": "string",
  • "archive": "string"
}
Response samples 
application/json
{
  • "hardwareConfigurations": [
    ],
  • "issues": [
    ]
}
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.


SecurityBearer 
Request 
path Parameters
regionId
required
string <uuid> 
Specifies the system ID assigned in the Veeam Backup for Google Cloud REST API to a region for which the set of worker profiles is added.


 
header Parameters
x-api-version
required
string
 Default:  1.4-rev0
Specifies the current revision of the Veeam Backup for Google Cloud 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 
application/json
{ }

    
    

                                

                                    
Document updated 11/19/2025
Page content applies to build 7.0.0.47