Veeam Backup for Google Cloud 7
REST API Reference
Related documents

SQL Restore Points

The /sqlInstance/restorePoints resource collection represents all restore points created for Cloud SQL instances with Veeam Backup for Google Cloud.

Get SQL Instance Restore Points

The HTTP GET request to the sqlInstance/restorePoints endpoint retrieves a list of all restore points created for Cloud SQL 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/sqlInstance/restorePoints
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "pagination": {
    }
}
Get SQL Instance Restore Point Data
The HTTP GET request to the sqlInstance/restorePoints/{restorePointId} endpoint retrieves information on a specific restore point created for a Cloud SQL 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 SQL 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/sqlInstance/restorePoints/{restorePointId}
Request samples 
Response samples 
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "creationTimeUtc": "2019-08-24T14:15:22Z",
  • "type": "Backup",
  • "sqlInstanceProjectId": "string",
  • "sqlInstanceName": "string"
}
Get Protected Cloud SQL Instance Configuration
The HTTP GET request to the sqlInstance/restorePoints/{restorePointId}/sqlInstanceConfig endpoint retrieves information on configuration of a Cloud SQL 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 SQL 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/sqlInstance/restorePoints/{restorePointId}/sqlInstanceConfig
Request samples 
Response samples 
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "backupId": "eb7cea43-10b2-42dd-8819-ab9aed37565f",
  • "creationTimeUtc": "2019-08-24T14:15:22Z",
  • "allowSslOnly": true,
  • "machineType": "string",
  • "diskType": "SSD",
  • "edition": "EditionUnspecified",
  • "diskSize": 0,
  • "diskAutoResize": true,
  • "collation": "string",
  • "privateIpEnabled": true,
  • "privateNetwork": "string",
  • "publicIpEnabled": true,
  • "publicNetworks": [
    ],
  • "haveConfigSaved": true
}
Perform Cloud SQL Instance Restore
The HTTP POST request to the sqlInstance/restorePoints/{restorePointId}/restoreInstance endpoint performs restore of a Cloud SQL instance from 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 SQL 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 Cloud SQL 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 SQL instance.


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


 
restoreConfig
boolean
Defines whether to restore configuration settings of the Cloud SQL instance that are not specified in the request body. If the False value is specified for the parameter, the instance will be restored with the default configuration settings.


 
locationId
string <uuid> 
Specifies the system ID assigned in the Veeam Backup for Google Cloud REST API to a Google Cloud region in which the restored Cloud SQL instance will reside.


 
primaryZoneId
string <uuid> 
[Applies if you want to specify the target availability zone for the restored Cloud SQL instance, or if you want the instance to operate in multiple zones] Specifies the system ID assigned in the Veeam Backup for Google Cloud REST API to the target or primary availability zone.


 
multipleZones
boolean
Defines whether the restore Cloud SQL instance will operate in multiple availability zones.


 
secondaryZoneId
string <uuid> 
[Applies if the True value is set for the multipleZones parameter] Specifies the system ID assigned in the Veeam Backup for Google Cloud REST API to the secondary availability zone.


 
instanceName
string
Specifies the name for the restored Cloud SQL instance.


 
machineType
string
Specifies a machine type for the restored Cloud SQL instance.


 
encryptionKeyId
string <uuid> 
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 Cloud SQL instance.


 
allowSslOnly
boolean
Defines whether only SSL connections will be allowed to the restored Cloud SQL instance.


 
diskType
string (ESqlDiskType) 
Specifies the type of the persistent disk attached to the backed-up Cloud SQL instance.


 Enum: "SSD" "HDD"  
diskSize
integer <int64> 
Specifies the storage size for the restored Cloud SQL instance.


 
diskAutoResize
boolean
Specifies whether the storage capacity will be increased automatically when it falls below a specified threshold size.


 
privateIpEnabled
boolean
Defines whether to enable private IP connectivity for the restored Cloud SQL instance.


 
privateVpcId
string
[Applies if you specified the true value for the privateIpEnabled parameter] Specifies the Google Cloud IDs of the VPC networks that are allowed to connect to the restored Cloud SQL instance.


 
publicIpEnabled
boolean
Defines whether to configure public IP connectivity for the restored Cloud SQL instance.


 
Array of objects (SqlAuthorizedNetworkModel) 
[Applies if you specified the true value for the publicIpEnabled parameter] Specifies CIDR range of IP addresses that are allowed to connect to the restored Cloud SQL instance.


 
Array of objects (Label) 
Specifies Google Cloud flags that must be assigned to the restored databases.


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


 
reason
string
Reason for restoring the Cloud SQL instance.


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


 
sqlCredentialsId
string <uuid> 
[Applies only to MySQL instances] Specifies the system ID assigned in the Veeam Backup for Google Cloud REST API to a Cloud SQL account used by Veeam Backup for Google Cloud to access the Cloud SQL instance that will become the owner of the restored 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/sqlInstance/restorePoints/{restorePointId}/restoreInstance
Request samples 
application/json
{
  • "projectId": "string",
  • "serviceAccountId": "a814cf67-aaac-43ae-acb4-8d34e82a4b4c",
  • "restoreToOriginal": true,
  • "restoreConfig": true,
  • "locationId": "1a5515a3-ba81-4a42-aee7-ad9ffc090a54",
  • "primaryZoneId": "c9719722-c4e3-4c76-8d06-f1900615912b",
  • "multipleZones": true,
  • "secondaryZoneId": "f1e1e55a-d9ba-4d8d-8d85-5e0c6b003fd1",
  • "instanceName": "string",
  • "machineType": "string",
  • "encryptionKeyId": "86aed764-c344-495f-9bff-19e15d04a950",
  • "allowSslOnly": true,
  • "diskType": "SSD",
  • "diskSize": 0,
  • "diskAutoResize": true,
  • "privateIpEnabled": true,
  • "privateVpcId": "string",
  • "publicIpEnabled": true,
  • "publicNetworks": [
    ],
  • "databaseFlags": [
    ],
  • "labels": [
    ],
  • "reason": "string",
  • "restoreOriginalLabels": true,
  • "sqlCredentialsId": "189b87f4-bd48-4a85-bbc1-1e481c8bda47"
}
Response samples 
{
  • "sessionIds": [
    ],
  • "issues": [
    ]
}
Perform Cloud SQL Database Recovery
The HTTP POST request to the sqlInstance/restorePoints/restoreDatabases endpoint performs restore of Cloud SQL 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 SQL databases.


 
serviceAccountId
required
string <uuid> 
Specifies the system ID assigned in the Veeam Backup for Google Cloud REST API to a service account whose permissions will be used to perform the restore operation.


 
instanceName
string
[Applies if Cloud SQL databases are restored to a new location, or with different settings] Specifies a name of the Cloud SQL instance that will become the owner of the restored databases.


 
sqlCredentialsId
string <uuid> 
[Applies only to PostgreSQL databases] Specifies the system ID assigned in the Veeam Backup for Google Cloud REST API to a Cloud SQL account used by Veeam Backup for Google Cloud to access the Cloud SQL instance that will become the owner of the restored databases.


 
Array of objects (SqlDatabaseRestoreSpec) 
Information on each Cloud SQL database that must be restored.


 
reason
string
Reason for restoring Cloud SQL 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/sqlInstance/restorePoints/restoreDatabase
Request samples 
application/json
{
  • "projectId": "string",
  • "serviceAccountId": "a814cf67-aaac-43ae-acb4-8d34e82a4b4c",
  • "instanceName": "string",
  • "sqlCredentialsId": "189b87f4-bd48-4a85-bbc1-1e481c8bda47",
  • "databases": [
    ],
  • "reason": "string"
}
Response samples 
{
  • "sessionIds": [
    ],
  • "issues": [
    ]
}

    
    

                                

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