Veeam Backup for Google Cloud 7
REST API Reference
Related documents

SMTP Accounts

The /smtp resource collection represents all SMTP server credentials records added to the Veeam Backup for Google Cloud configuration database.

Get Collection of SMTP Accounts

The HTTP GET request to the /smtp endpoint retrieves a list of all SMTP server credentials records 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/smtp
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "pagination": {
    }
}
Add SMTP Account
The HTTP POST request to the /smtp endpoint adds a new SMTP account to 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
name
required
string
Specifies a name for the SMTP account.


 
required
object (CredentialsSpec) 
Information on a credentials record.


 
description
string
Specifies a description for the SMTP 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/smtp
Request samples 
application/json
{
  • "name": "string",
  • "description": "string",
  • "credentials": {
    }
}
Response samples 
application/json
{
  • "smtpAccount": {
    },
  • "issues": [
    ]
}
Get SMTP Account Data
The HTTP GET request to the /smtp/{smtpAccountId} endpoint retrieves information on an SMTP account with the specified ID.


SecurityBearer 
Request 
path Parameters
smtpAccountId
required
string <uuid> 
System ID assigned in the Veeam Backup for Google Cloud REST API to an SMTP account.


 
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/smtp/{smtpAccountId}
Request samples 
Response samples 
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "description": "string",
  • "credentials": {
    }
}
Modify SMTP Account
The HTTP PUT request to the /smtp/{smtpAccountId} endpoint updates an SMTP account with the specified ID.


SecurityBearer 
Request 
path Parameters
smtpAccountId
required
string <uuid> 
System ID assigned in the Veeam Backup for Google Cloud REST API to an SMTP account.


 
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
name
required
string
Specifies a name for the SMTP account.


 
required
object (CredentialsSpec) 
Information on a credentials record.


 
description
string
Specifies a description for the SMTP 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.


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.


put/api/v1/smtp/{smtpAccountId}
Request samples 
application/json
{
  • "name": "string",
  • "description": "string",
  • "credentials": {
    }
}
Response samples 
application/json
{
  • "smtpAccount": {
    },
  • "issues": [
    ]
}
Remove SMTP Account
The HTTP DELETE request to the /smtp/{smtpAccountId} endpoint removes an SMTP account with the specified ID from the Veeam Backup for Google Cloud configuration database.


SecurityBearer 
Request 
path Parameters
smtpAccountId
required
string <uuid> 
System ID assigned in the Veeam Backup for Google Cloud REST API to an SMTP account.


 
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/smtp/{smtpAccountId}
Request samples 
Response samples 
application/json
{ }

    
    

                                

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