Veeam Backup for Google Cloud 7
REST API Reference
Related documents

Cloud SQL Accounts

The /credentials/sql resource collection represents all Cloud SQL accounts used to connect to Cloud SQL instances in Veeam Backup for Google Cloud.

Get Collection of Cloud SQL Accounts

The HTTP GET request to the /api/v1/credentials/sql endpoint retrieves a list of Cloud SQL accounts added to the Veeam Backup for Google Cloud configuration database.

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/credentials/sql
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "pagination": {
    }
}
Add Cloud SQL Account
The HTTP POST request to the /credentials/sql endpoint creates a new Cloud SQL account in the Veeam Backup for Google Cloud configuration database.


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
required
object (CredentialsDescriptorSpec) 
Specifies information on a Cloud SQL account.


 
userName
required
string
Specifies a user name for the Cloud SQL account.


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


 
password
string
Specifies a password for the Cloud SQL account.


 
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.


post/api/v1/credentials/sql
Request samples 
application/json
{
  • "descriptor": {
    },
  • "typeId": "caab7c42-4ce7-4bd5-bbab-6017cec730b7",
  • "userName": "string",
  • "password": "string"
}
Response samples 
application/json
{
  • "credentials": {
    },
  • "issues": [
    ]
}
Get Cloud SQL Account Data
The HTTP GET request to the /api/v1/credentials/sql/{id} endpoint retrieves information on a Cloud SQL account with the specified ID.


SecurityBearer 
Request 
path Parameters
id
required
string <uuid> 
Specifies the system ID assigned to a Cloud SQL account in the Veeam Backup for Google Cloud REST API.


 
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/credentials/sql/{id}
Request samples 
Response samples 
application/json
{
  • "descriptor": {
    },
  • "userName": "string",
  • "type": {
    }
}
Update Cloud SQL Account
The HTTP PUT request to the /credentials/sql endpoint updates credentials of a Cloud SQL account with the specified ID.


SecurityBearer 
Request 
path Parameters
id
required
string <uuid> 
Specifies the system ID assigned to a Cloud SQL account in the Veeam Backup for Google Cloud REST API.


 
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
required
object (CredentialsDescriptorSpec) 
Specifies information on a Cloud SQL account.


 
userName
required
string
Specifies a new user name for the Cloud SQL account.


 
password
string
Specifies a new password for the Cloud SQL account.


 
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.


put/api/v1/credentials/sql/{id}
Request samples 
application/json
{
  • "descriptor": {
    },
  • "userName": "string",
  • "password": "string"
}
Response samples 
application/json
{
  • "credentials": {
    },
  • "issues": [
    ]
}
Remove Cloud SQL Account
The HTTP DELETE request to the /credentials/sql/{id} endpoint removes a Cloud SQL account with the specified ID.


SecurityBearer 
Request 
path Parameters
id
required
string <uuid> 
Specifies the system ID assigned to a Cloud SQL account in the Veeam Backup for Google Cloud REST API.


 
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 
204
No Content


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/credentials/sql/{id}
Request samples 
Response samples 
application/json
{ }
Get Collection of Cloud SQL Account Types
The HTTP GET request to the /api/v1/credentials/sql/types endpoint retrieves a list of types which can be applied for newly created Cloud SQL accounts.


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/credentials/sql/types
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "pagination": {
    }
}

    
    

                                

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