Veeam Backup for Google Cloud 7
REST API Reference
Related documents

VM Instances

The /vmInstances resource collection represents all VM instances that reside in Google Cloud regions specified in the backup policy settings and can be protected by Veeam Backup for Google Cloud.

Get Collection of VM Instances

The HTTP GET request to the /vmInstances endpoint retrieves a list of all VM instances added to the Veeam Backup for Google Cloud database as a result of infrastructure rescanning operations for VM instances.

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/vmInstances
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "pagination": {
    }
}
Get VM Instance Data
The HTTP GET request to the /vmInstances/{vmInstanceId} endpoint retrieves information on a VM instance with the specified ID.


SecurityBearer 
Request 
path Parameters
vmInstanceId
required
string
Google Cloud ID assigned to a VM instance.


 
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/vmInstances/{vmInstanceId}
Request samples 
Response samples 
application/json
{
  • "id": "string",
  • "resourceId": "string",
  • "name": "string",
  • "locationId": "1a5515a3-ba81-4a42-aee7-ad9ffc090a54",
  • "locationName": "string",
  • "projectId": "string",
  • "instanceType": "string",
  • "dnsName": "string",
  • "accounts": [
    ]
}
Get Restore Points of VM Instance
The HTTP GET request to the /vmInstances/{vmInstanceId}/restorePoints endpoint retrieves a list of all restore points created by Veeam Backup for Google Cloud for a specific VM instance.


SecurityBearer 
Request 
path Parameters
vmInstanceId
required
string
Google Cloud ID assigned to a VM instance.


 
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/vmInstances/{vmInstanceId}/restorePoints
Request samples 
Response samples 
application/json
{
  • "restorePoints": [
    ],
  • "pagination": {
    }
}
Remove VM Instance Restore Points
The HTTP DELETE request to the /vmInstances/{vmInstanceId}/restorePoints endpoint removes restore points of a VM instance with the specified name from the Veeam Backup for Google Cloud configuration database.


SecurityBearer 
Request 
path Parameters
vmInstanceId
required
string
Google Cloud ID assigned to a VM instance.


 
query Parameters
type
required
string
Type of the restore point.


 Enum: "All" "Backup" "Snapshot" "ManualSnapshot" "AllSnapshots" "ArchiveBackup" "StandardBackup"  
manualSnapshotId
string <uuid> 
System ID assigned in the Veeam Backup for Google Cloud REST API to a manual snapshot.


 
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.


delete/api/v1/vmInstances/{vmInstanceId}/restorePoints
Request samples 
Response samples 
{
  • "sessionIds": [
    ],
  • "issues": [
    ]
}
Get VM Instance Sessions Data
The HTTP GET request to the /vmInstances/{vmInstanceId}/sessions endpoint retrieves a list of sessions associated with a specified VM instance.


SecurityBearer 
Request 
path Parameters
vmInstanceId
required
string
Google Cloud ID assigned to a VM instance.


 
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/vmInstances/{vmInstanceId}/sessions
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "pagination": {
    }
}
Create Snapshot of VM Instance
The HTTP POST request to the  /vmInstances/{vmInstanceId}/snapshot endpoint creates a manual snapshot of a VM instance with the specified ID. 
NOTE 
 When you create a snapshot manually, Veeam Backup for Google Cloud detects if there is a snapshot chain for the processed VM instance.  If the snapshot chain exists, Veeam Backup for Google Cloud continues the existing chain. Otherwise, the created snapshot starts a new snapshot chain for the processed VM instance.


SecurityBearer 
Request 
path Parameters
vmInstanceId
required
string
Google Cloud ID assigned to a VM instance.


 
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
serviceAccountId
required
string <uuid> 
 
Array of objects (TagModel) 
[Applies if you want to assign custom labels] Information on label key and value.


 
copyTagsFromVolumeEnabled
boolean
Defines whether to assign to the snapshot labels of persistent disks attached to processed VM instances. The default value is false.


 
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.


post/api/v1/vmInstances/{vmInstanceId}/snapshot
Request samples 
application/json
{
  • "serviceAccountId": "a814cf67-aaac-43ae-acb4-8d34e82a4b4c",
  • "additionalTags": [
    ],
  • "copyTagsFromVolumeEnabled": true
}
Response samples 
{
  • "sessionIds": [
    ],
  • "issues": [
    ]
}
Infrastructure Rescan for Google Cloud Resources
The HTTP POST request to the /vmInstances/rescan endpoint runs the Google Cloud infrastructure rescanning operation.


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
Array of objects (ProjectAccountSpec) 
Specifies the information on a project.


 
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.


429
Too Many Requests. The user has sent too many requests in a given amount of time.


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/vmInstances/rescan
Request samples 
application/json
{
  • "projects": [
    ]
}
Response samples 
{
  • "sessionIds": [
    ],
  • "issues": [
    ]
}

    
    

                                

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