Veeam Backup for Google Cloud 7
REST API Reference
Related documents

VM Instance Restore Points

The /vmInstance/restorePoints resource collection represents all restore points created for VM instances in Veeam Backup for Google Cloud.

Get VM Instance Restore Points

The HTTP GET request to the vmInstance/restorePoints endpoint retrieves a list of all restore points created for VM instances by 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/vmInstance/restorePoints
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "pagination": {
    }
}
Get VM Instance Restore Point Data
The HTTP GET request to the vmInstance/restorePoints/{restorePointId} endpoint retrieves information on a restore point with the specified ID.


SecurityBearer 
Request 
path Parameters
restorePointId
required
string <uuid> 
System ID assigned in the Veeam Backup for Google Cloud REST API to a restore point of 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/vmInstance/restorePoints/{restorePointId}
Request samples 
Response samples 
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "size": 0,
  • "creationTimeUtc": "2019-08-24T14:15:22Z",
  • "type": "Backup",
  • "vmInstanceId": "string"
}
Get Snapshots
The HTTP GET request to the vmInstance/restorePoints/{restorePointId}/snapshots endpoint retrieves a list of all snapshots associated with a snapshot restore point with the specified ID.


SecurityBearer 
Request 
path Parameters
restorePointId
required
string <uuid> 
System ID assigned in the Veeam Backup for Google Cloud REST API to a restore point of 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/vmInstance/restorePoints/{restorePointId}/snapshots
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "pagination": {
    }
}
Get Backups
The HTTP GET request to the vmInstance/restorePoints/{restorePointId}/backups endpoint retrieves a list of all snapshots associated with a backup restore point with the specified ID.


SecurityBearer 
Request 
path Parameters
restorePointId
required
string <uuid> 
System ID assigned in the Veeam Backup for Google Cloud REST API to a restore point of 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/vmInstance/restorePoints/{restorePointId}/backups
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "pagination": {
    }
}
Get Protected VM Instance Configuration
The HTTP GET request to the vmInstance/restorePoints/{restorePointId}/vmConfig endpoint retrieves information on configuration of a VM instance for which a restore point with the specified ID was created.


SecurityBearer 
Request 
path Parameters
restorePointId
required
string <uuid> 
System ID assigned in the Veeam Backup for Google Cloud REST API to a restore point of 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.


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/vmInstance/restorePoints/{restorePointId}/vmConfig
Request samples 
Response samples 
application/json
{
  • "machineType": "string",
  • "sourceMachineImage": "string",
  • "osType": "string",
  • "hostName": "string",
  • "staticIp": true,
  • "vmInstanceSizeGb": 0,
  • "regionId": "a29f01e1-8a8d-451e-b685-f8b0b4ec4767"
}
Perform File-Level Recovery
The HTTP POST request to the vmInstance/restorePoints/{restorePointId}/startflr endpoint performs endpoint performs restore of VM instance files and folders using a restore point with the specified ID.


SecurityBearer 
Request 
path Parameters
restorePointId
required
string <uuid> 
System ID assigned in the Veeam Backup for Google Cloud REST API to a restore point of 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
reason
string
Specifies a reason for the restore operation.


 
enabledRol
boolean
Defines whether to perform the file-level recovery to the original location.


 
countQueues
integer <int32> 
Specifies the number of simultaneous connections that the worker instance will establish when addressing the target instance during the restore operation.


 
keepApplication
boolean
Defines whether to keep restore utilities on the target instance after the restore operation completes.


 
serviceAccountId
string <uuid> 
Specifies the system ID assigned in the Veeam Backup for Google Cloud REST API to a service account that will be used to manage the restored files and folders.


 
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/vmInstance/restorePoints/{restorePointId}/startflr
Request samples 
application/json
{
  • "reason": "string",
  • "enabledRol": true,
  • "countQueues": 0,
  • "keepApplication": true,
  • "serviceAccountId": "a814cf67-aaac-43ae-acb4-8d34e82a4b4c"
}
Response samples 
{
  • "sessionIds": [
    ],
  • "issues": [
    ]
}
Perform VM Instance Restore
The HTTP POST request to the vmInstance/restorePoints/{restorePointId}/restoreInstance endpoint performs full restore of VM instance using a restore point with the specified ID.


SecurityBearer 
Request 
path Parameters
restorePointId
required
string <uuid> 
System ID assigned in the Veeam Backup for Google Cloud REST API to a restore point of 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
restoreToOriginal
required
boolean
Defines whether to restore a VM instance to the original location.


 
projectId
required
string
Specifies the Google Cloud ID assigned to a project that will be used to manage the restored VM instance.


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


 
availabilityZoneId
string <uuid> 
[Applies if you restore the VM instance to a new location, or with different settings] Specifies the system ID assigned in the Veeam Backup for Google Cloud REST API to the target availability zone for the restored VM instance.


 
instanceName
string
[Applies if you restore the VM instance to a new location, or with different settings] Specifies a name for the restored VM instance.


 
instanceType
string
[Applies if you restore the VM instance to a new location, or with different settings] Specifies the type for the restored VM instance.


 
subnetworkId
string
[Applies if you restore the VM instance to a new location, or with different settings] Specifies the Google Cloud ID assigned to the subnet to which the restored VM instance must be connected.


 
networkTagsRestore
boolean
[Applies if you restore the VM instance to a new location, or with different settings] Defines whether to assign to the restored VM instance labels from the source VM instance.


 
staticIpRestore
boolean
[Applies if you restore the VM instance to a new location, or with different settings] Defines whether to associate a static external IP address of the source VM instance with the restored VM instances.
 
 Note Veeam Backup for Google Cloud cannot assign a static external IP address to a restored VM instance if the source instance does not have the address reserved. To learn how to reserve static external IP addresses for VM instances, see Google Cloud documentation.


 
encryptionKeyId
string <uuid> 
[Applies if you restore the VM instance to a new location, or with different settings] Specifies the system ID assigned in the Veeam Backup for Google Cloud REST API to an encryption key (CMEK) that will be used to encrypt the restored VM instance.


 
startInstance
boolean
Defines whether to start the restored VM instance as soon as the restore process completes.


 
reason
string
Specifies a reason for the restore operation.


 
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/vmInstance/restorePoints/{restorePointId}/restoreInstance
Request samples 
application/json
{
  • "projectId": "string",
  • "serviceAccountId": "a814cf67-aaac-43ae-acb4-8d34e82a4b4c",
  • "restoreToOriginal": true,
  • "availabilityZoneId": "e8af458c-4211-47cc-becb-5eb05af68c0d",
  • "instanceName": "string",
  • "instanceType": "string",
  • "subnetworkId": "string",
  • "networkTagsRestore": true,
  • "staticIpRestore": true,
  • "encryptionKeyId": "86aed764-c344-495f-9bff-19e15d04a950",
  • "startInstance": true,
  • "reason": "string"
}
Response samples 
{
  • "sessionIds": [
    ],
  • "issues": [
    ]
}
Perform Volume-Level Restore
The HTTP POST request to the vmInstance/restorePoints/{restorePointId}/restoreDisk endpoint performs volume-level restore using a restore point with the specified ID.


SecurityBearer 
Request 
path Parameters
restorePointId
required
string <uuid> 
System ID assigned in the Veeam Backup for Google Cloud REST API to a restore point of 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
restoreToOriginal
required
boolean
Defines whether to restore a persistent disk to the original location.


 
vmInstanceId
required
string
System ID assigned in the Veeam Backup for Google Cloud REST API to a VM instance to which the specified persistent disk is attached.


 
projectId
required
string
Google Cloud ID assigned to a project where the restored persistent disks will belong.


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


 
availabilityZoneId
string <uuid> 
[Applies if you restore persistent disks to a new location, or with different settings] Specifies the system ID assigned in the Veeam Backup for Google Cloud REST API to the target availability zone for the restored persistent disks.


 
preserveEncryptionForVolumes
boolean
[Applies if you restore persistent disks to a new location, or with different settings] Defines whether to apply the existing encryption scheme to the restored persistent disks.


 
encryptionKeyId
string <uuid> 
[Applies if you selected not to apply the existing encryption scheme to the restored persistent disks] Specifies the system ID assigned in the Veeam Backup for Google Cloud REST API to an encryption key (CMEK) that will be used to encrypt the restored disks.


 
Array of objects (CloudInstanceVolumeRestoreSettings) 
Information on each restored persistent disk.


 
reason
string
Specifies a reason for the restore operation.


 
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/vmInstance/restorePoints/{restorePointId}/restoreDisk
Request samples 
application/json
{
  • "vmInstanceId": "string",
  • "restoreToOriginal": true,
  • "projectId": "string",
  • "serviceAccountId": "a814cf67-aaac-43ae-acb4-8d34e82a4b4c",
  • "availabilityZoneId": "e8af458c-4211-47cc-becb-5eb05af68c0d",
  • "preserveEncryptionForVolumes": true,
  • "encryptionKeyId": "86aed764-c344-495f-9bff-19e15d04a950",
  • "disks": [
    ],
  • "reason": "string"
}
Response samples 
{
  • "sessionIds": [
    ],
  • "issues": [
    ]
}

    
    

                                

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