Veeam Backup for Google Cloud 7
REST API Reference
Related documents

Storage Buckets

The /buckets resource collection represents all storage buckets available for Veeam Backup to Google Cloud.

Get Collection of Storage Buckets

The HTTP GET request to the /buckets endpoint retrieves a list of all storage buckets available for 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/buckets
Request samples 
Response samples 
{
  • "data": [
    ],
  • "pagination": {
    }
}
Get Storage Bucket Data
The HTTP GET request to the /buckets/{bucketId} endpoint retrieves information on a storage bucket with the specified ID.


SecurityBearer 
Request 
path Parameters
bucketId
required
string <uuid> 
System ID assigned to a storage bucket 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.


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/buckets/{bucketId}
Request samples 
Response samples 
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "location": "string",
  • "projectId": "string",
  • "accounts": [
    ]
}
Get Storage Bucket Folders
The HTTP GET request to the /buckets/{bucketId}/folders endpoint retrieves a list of all folders existing in a storage bucket with the specified ID.


SecurityBearer 
Request 
path Parameters
bucketId
required
string <uuid> 
System ID assigned to a storage bucket in the Veeam Backup for Google Cloud REST API.


 
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.


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/buckets/{bucketId}/folders
Request samples 
Response samples 
{
  • "data": [
    ],
  • "pagination": {
    }
}
Infrastructure Rescan for Storage Buckets
The HTTP POST request to the /buckets/rescan/{projectId}/accounts/{serviceAccountId} endpoint runs the bucket rescanning operation for a Google Cloud project with the specified ID.


SecurityBearer 
Request 
path Parameters
projectId
required
string
Google Cloud ID assigned to a project.


 
serviceAccountId
required
string <uuid> 
System ID assigned in the Veeam Backup for Google Cloud REST API to a service 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.


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/buckets/rescan/{projectId}/accounts/{serviceAccountId}
Request samples 
Response samples 
application/json
{
  • "sessionIds": [
    ],
  • "issues": [
    ]
}
Infrastructure Rescan for Storage Bucket Folders
The HTTP POST request to the /buckets/{bucketId}/accounts/{serviceAccountId}/folders/rescan endpoint runs the folder rescanning operation for a storage bucket with the specified ID.


SecurityBearer 
Request 
path Parameters
bucketId
required
string <uuid> 
System ID assigned to a storage bucket in the Veeam Backup for Google Cloud REST API.


 
serviceAccountId
required
string <uuid> 
System ID assigned in the Veeam Backup for Google Cloud REST API to a service 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
hmacAccessId
required
string
Specifies the access ID of an HMAC key.


 
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.


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/buckets/{bucketId}/accounts/{serviceAccountId}/folders/rescan
Request samples 
application/json
{
  • "hmacAccessId": "string"
}
Response samples 
application/json
{
  • "sessionIds": [
    ],
  • "issues": [
    ]
}

    
    

                                

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