Veeam Backup for Google Cloud 7
REST API Reference
Related documents

Cloud Spanner Instance Restore Points

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

Get Cloud Spanner Instance Restore Points

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


SecurityBearer 
Request 
path Parameters
restorePointId
required
string <uuid> 
Specifies the system ID assigned in the Veeam Backup for Google Cloud REST API to a restore point of a Cloud Spanner 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/spannerInstance/restorePoints/{restorePointId}
Request samples 
Response samples 
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "creationTimeUtc": "2019-08-24T14:15:22Z",
  • "type": "Backup",
  • "spannerInstanceProjectId": "string",
  • "spannerInstanceId": "string"
}
Get Protected Cloud Spanner Instance Configuration
The HTTP GET request to the spannerInstance/restorePoints/{restorePointId}/spannerInstanceConfig endpoint retrieves information on configuration of a Cloud Spanner instance for which a restore point with the specified ID was created.


SecurityBearer 
Request 
path Parameters
restorePointId
required
string <uuid> 
Specifies the system ID assigned in the Veeam Backup for Google Cloud REST API to a restore point of a Cloud Spanner 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/spannerInstance/restorePoints/{restorePointId}/spannerInstanceConfig
Request samples 
Response samples 
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "backupId": "eb7cea43-10b2-42dd-8819-ab9aed37565f",
  • "creationTimeUtc": "2019-08-24T14:15:22Z",
  • "instanceId": "string",
  • "displayName": "string",
  • "instanceConfig": {
    },
  • "nodes": 0,
  • "processingUnits": 0,
  • "labels": [
    ]
}
Perform Cloud Spanner Instance Restore
The HTTP POST request to the spannerInstance/restorePoints/{restorePointId}/restoreInstance endpoint restores a Cloud Spanner instance using a restore point with the specified ID.


SecurityBearer 
Request 
path Parameters
restorePointId
required
string <uuid> 
Specifies the system ID assigned in the Veeam Backup for Google Cloud REST API to a restore point of a Cloud Spanner 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 the Cloud Spanner instance to the original location.
Note If the True value is set for the restoreToOriginal parameter, proceed to the reason and restoreOriginalLabels parameters in the request body.


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


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


 
instanceId
string
Specifies the Google Cloud ID assigned to the restored Cloud Spanner instance.


 
displayName
string
Specifies the name of the Cloud Spanner instance displayed in the Veeam Backup for Google Cloud UI.


 
object (SpannerInstanceConfigSpec) 
Specifies the configuration of the Cloud Spanner instance.


 
nodes
integer
Specifies the number of nodes of the Cloud Spanner instance.
 Note: Either nodes or processing units must be specified.


 
processingUnits
integer
Specifies the number of processing units of the Cloud Spanner instance.
 Note: Either nodes or processing units must be specified.


 
object (SpannerRestoreEncryptionSpec) 
Specifies the encryption options for the Cloud Spanner database restore operation.


 
Array of objects (Label) 
Specifies the list of labels that will be assigned to the restored Cloud Spanner instance.


 
reason
string
Specifies a reason for the restore operation.


 
restoreOriginalLabels
boolean
Defines whether to restore original labels to the restored Cloud Spanner instance.


 
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/spannerInstance/restorePoints/{restorePointId}/restoreInstance
Request samples 
application/json
{
  • "projectId": "string",
  • "serviceAccountId": "a814cf67-aaac-43ae-acb4-8d34e82a4b4c",
  • "restoreToOriginal": true,
  • "instanceId": "string",
  • "displayName": "string",
  • "instanceConfig": {
    },
  • "nodes": 0,
  • "processingUnits": 0,
  • "encryptionOptions": {
    },
  • "labels": [
    ],
  • "reason": "string",
  • "restoreOriginalLabels": true
}
Response samples 
{
  • "sessionIds": [
    ],
  • "issues": [
    ]
}
Perform Cloud Spanner Database Recovery
The HTTP POST request to the spannerInstance/restorePoints/restoreDatabases endpoint performs restore of Cloud Spanner databases from a restore point with the specified ID.


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 that will be used to manage the restored Cloud Spanner databases.


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


 
instanceId
required
string
[Applies if Cloud Spanner databases are restored to a new location, or with different settings] Specifies the Google Cloud ID assigned to the Cloud Spanner instance that will host the restored databases.


 
required
Array of objects (SpannerDatabaseRestoreSpec) 
Specifies the information on each Cloud Spanner database that will be restored.


 
reason
string
Reason for restoring Cloud Spanner databases.


 
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/spannerInstance/restorePoints/restoreDatabase
Request samples 
application/json
{
  • "projectId": "string",
  • "serviceAccountId": "a814cf67-aaac-43ae-acb4-8d34e82a4b4c",
  • "instanceId": "string",
  • "databases": [
    ],
  • "reason": "string"
}
Response samples 
{
  • "sessionIds": [
    ],
  • "issues": [
    ]
}

    
    

                                

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