Veeam Backup for Google Cloud 7
REST API Reference
Related documents

Sessions

The /sessions resource collection represents statistics for every performed operation (VM instance backup, restore, snapshot creation and so on) in Veeam Backup for Google Cloud.

Get Collection of Sessions

The HTTP GET request to the /sessions endpoint retrieves a list of all sessions stored in the Veeam Backup for Google Cloud 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/sessions
Request samples 
Response samples 
{
  • "data": [
    ],
  • "pagination": {
    }
}
Get Session Data
The HTTP GET request to the /sessions/{sessionId} endpoint retrieves information on a session with the specified ID.


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


 
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/sessions/{sessionId}
Request samples 
Response samples 
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "sessionType": "Unknown",
  • "creationTimeUtc": "2019-08-24T14:15:22Z",
  • "endTimeUtc": "2019-08-24T14:15:22Z",
  • "state": "Running",
  • "result": "Running",
  • "reason": "string"
}
Stop Session Processing
The HTTP POST request to the /sessions/{sessionId}/stop endpoint stops processing of a session with the specified ID.


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


 
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/sessions/{sessionId}/stop
Request samples 
Response samples 
application/json
{
  • "success": true,
  • "issues": [
    ]
}
Get Session Log Details
The HTTP GET request to the /sessions/{sessionId}/logs endpoint retrieves log details of a session with the specified ID.


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


 
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/sessions/{sessionId}/logs
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "pagination": {
    }
}
Get Items Removed During Session
The HTTP GET request to the /sessions/{retentionSessionId}/deletedItems endpoint retrieves a list of restore points that were removed during a session with the specified ID.


SecurityBearer 
Request 
path Parameters
retentionSessionId
required
string <uuid> 
Specifies the system ID assigned in the Veeam Backup for Google Cloud REST API to a retention activity session.


 
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/sessions/{retentionSessionId}/deletedItems
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "pagination": {
    }
}
Get Items Protected During Session
The HTTP GET request to the /sessions/{backupSessionId}/protectedItems endpoint retrieves a list of VM or Cloud SQL instances protected during a session with the specified ID.


SecurityBearer 
Request 
path Parameters
backupSessionId
required
string <uuid> 
System ID assigned in the Veeam Backup for Google Cloud REST API to a backup activity session.


 
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/sessions/{backupSessionId}/protectedItems
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "pagination": {
    }
}
Get Items Restored During Session
The HTTP GET request to the /sessions/{restoreSessionId}/restoredItems endpoint retrieves a list of items that were restored during a session with the specified ID.


SecurityBearer 
Request 
path Parameters
restoreSessionId
required
string <uuid> 
System ID assigned in the Veeam Backup for Google Cloud REST API to a restore activity session.


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

    
    

                                

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