Veeam Backup for Google Cloud 7
REST API Reference
Related documents

Licensing

The /licensing resource collection represents Veeam Backup for Google Cloud license information, license usage data and alerts on license usage and expiration.

Get License Details

The HTTP GET request to the /licensing/license endpoint retrieves information on the installed Veeam Backup for Google Cloud license.

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.

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/licensing/license
Request samples 
Response samples 
application/json
{
  • "licenseType": "BYOL",
  • "licenseStatus": {
    },
  • "usedInstancesCount": 0,
  • "totalInstancesCount": 0,
  • "isLicenseManagementAllowed": true,
  • "byolLicense": {
    },
  • "managedLicense": {
    }
}
Install License
The HTTP POST request to the /licensing/license endpoint allows you to upload a license file obtained from Veeam.
 
NOTE
 The information in this section applies only to the BYOL edition of Veeam Backup for Google Cloud. 


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: multipart/form-data
required
licenseFile
required
string <binary> 
The .lic license file to upload.


 
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/licensing/license
Request samples 
Response samples 
application/json
{
  • "success": true,
  • "issues": [
    ]
}
Remove License
The HTTP DELETE request to the /licensing/license endpoint removes a BYOL license installed on the backup appliance.


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.


 
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.


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/licensing/license
Request samples 
Response samples 
application/json
{ }
Export License Usage Report
The HTTP POST request to the /licensing/license/export endpoint exports the license usage report to a .CSV or an .XML file. To specify the required type of the file, use the Accept request header.


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.


 
Responses 
200
OK


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/licensing/license/export
Request samples 
Get Instances Consuming License Units
The HTTP GET request to the /licensing/licensedVmInstances endpoint retrieves a list of instances consuming license units.


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/licensing/licensedVmInstances
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "pagination": {
    }
}
Get License Notifications
The HTTP GET request to the /licensing/notifications endpoint retrieves alerts on license usage and expiration time fired in Veeam Backup for Google Cloud.
 
NOTE 
 To resolve alerts, send the HTTP POST request to the /licensing/notifications/resolve endpoint. 


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/licensing/notifications
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "pagination": {
    }
}
Resolve License Notifications
The HTTP POST request to the /licensing/notifications/resolve endpoint resolves license alerts received from the Veeam Backup for Google Cloud appliance.


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
notificationsToResolve
required
Array of strings (ELicenseNotificationType) 
Specifies the type of notifications you want to resolve.


Items Enum: "Expiration" "Exceed" "PreExpiration" "ExceedPostGrace" "ExpirationGrace"  
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/licensing/notifications/resolve
Request samples 
application/json
{
  • "notificationsToResolve": [
    ]
}
Response samples 
application/json
{ }

    
    

                                

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