Veeam Backup for Google Cloud 7
REST API Reference
Related documents

Cloud Spanner Instances

The /spannerInstances resource collection represents all Cloud Spanner 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 Cloud Spanner Instances

The HTTP GET request to the /spannerInstances endpoint retrieves a list of all Cloud Spanner instances added to the Veeam Backup for Google Cloud database as a result of infrastructure rescanning operations for Cloud Spanner 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/spannerInstances
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "pagination": {
    }
}
Get Cloud Spanner Instance Data
The HTTP GET request to the /spannerInstances/projects/{projectId}/{instanceName} endpoint retrieves information on a Cloud Spanner instance with the specified name.


SecurityBearer 
Request 
path Parameters
projectId
required
string
Specifies the Google Cloud ID assigned to a project where the Cloud Spanner instance belongs.


 
instanceName
required
string
Specifies the name of the 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/spannerInstances/projects/{projectId}/{instanceName}
Request samples 
Response samples 
application/json
{
  • "name": "string",
  • "displayName": "string",
  • "projectId": "string",
  • "configuration": {
    },
  • "accounts": [
    ]
}
Create Snapshot of Cloud Spanner Instance
The HTTP POST request to the /spannerInstances/projects/{projectId}/accounts/{serviceAccountId}/{instanceName}/snapshot endpoint creates a manual snapshot of a Cloud Spanner instance with the specified ID.


SecurityBearer 
Request 
path Parameters
projectId
required
string
Specifies the Google Cloud ID assigned to a project where the Cloud Spanner instance belongs.


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


 
instanceName
required
string
Specifies a name of the 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.


post/api/v1/spannerInstances/projects/{projectId}/accounts/{serviceAccountId}/{instanceName}/snapshot
Request samples 
Response samples 
{
  • "sessionIds": [
    ],
  • "issues": [
    ]
}
Infrastructure Rescan for Cloud Spanner Instances
The HTTP POST request to the /spannerInstances/rescan endpoint runs the Google Cloud infrastructure rescanning operation for Cloud Spanner 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.


 
Request Body schema: application/json
Array of objects (ProjectAccountSpec) 
Specifies a Google Cloud ID assigned to projects that contain Cloud SQL instances for which the rescanning operation will run.


 
Responses 
200
Success


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


SecurityBearer 
Request 
path Parameters
projectId
required
string
Specifies the Google Cloud ID assigned to a project where a Cloud Spanner instance belongs.


 
instanceName
required
string
Specifies the name of the Cloud Spanner instance.


 
query Parameters
type
required
string
Specifies a type of a restore point that will be removed.


 Enum: "All" "Backup" "Snapshot" "ManualSnapshot" "AllSnapshots" "ArchiveBackup" "StandardBackup"  
manualSnapshotId
string <uuid> 
[Applies only if you specified the ManualSnapshot value for the type parameter] System ID assigned in the Veeam Backup for Google Cloud REST API to a manually created 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/spannerInstances/projects/{projectId}/{instanceName}/restorePoints
Request samples 
Response samples 
{
  • "sessionIds": [
    ],
  • "issues": [
    ]
}

    
    

                                

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