Veeam Backup for Google Cloud 7
REST API Reference
Related documents

User Accounts

The /users resource collection represents all user accounts added to the Veeam Backup for Google Cloud database.

Get Collection of User Accounts

The HTTP GET request to the /users endpoint returns a list of all user accounts created in 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 of a resource collection in the response. To learn how to use the orderby parameter, see the Veeam Backup for Google Cloud REST API Reference, 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 to return 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/users
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "pagination": {
    }
}
Add User Account
The HTTP POST request to the /users endpoint adds a new user 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 a user account.


 
password
required
string
Specifies password for the user account.


 
roleIds
required
Array of strings <uuid> 
System IDs assigned to the user roles in Veeam Backup for Google Cloud.


 
description
string
Specifies description for the user 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/users
Request samples 
application/json
{
  • "name": "string",
  • "description": "string",
  • "password": "string",
  • "roleIds": [
    ]
}
Response samples 
application/json
{
  • "user": {
    },
  • "issues": [
    ]
}
Get User Account Data
The HTTP GET request to the /users/{name} endpoint retrieves information on a specific user account.


SecurityBearer 
Request 
path Parameters
name
required
string
Specifies the name of a user 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/users/{name}
Request samples 
Response samples 
application/json
{
  • "name": "string",
  • "description": "string",
  • "mfaEnabled": true,
  • "type": "DefaultAdmin",
  • "roles": [
    ]
}
Modify User Account
The HTTP PUT request to the /users/{name} endpoint updates settings of a specific user account.


SecurityBearer 
Request 
path Parameters
name
required
string
Specifies the name of a user 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
description
string
Specify a new description for the user account.


 
roleIds
Array of strings <uuid> 
System IDs assigned in the Veeam Backup for Google Cloud REST API to user roles.


 
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/users/{name}
Request samples 
application/json
{
  • "description": "string",
  • "roleIds": [
    ]
}
Response samples 
application/json
{
  • "user": {
    },
  • "issues": [
    ]
}
Remove User Account
The HTTP DELETE request to the /users/{name} endpoint removes a specific user account.


SecurityBearer 
Request 
path Parameters
name
required
string
Specifies the name of a user 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/users/{name}
Request samples 
Response samples 
application/json
{ }
Disable MFA for User Account
The HTTP POST request to the /users/{name}/mfaDisable endpoint disables MFA for a specific user account.


SecurityBearer 
Request 
path Parameters
name
required
string
Specifies the name of a user 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.


post/api/v1/users/{name}/mfaDisable
Request samples 
Response samples 
application/json
{
  • "success": true,
  • "issues": [
    ]
}
Get MFA Secret Key
The HTTP POST request to the /users/{name}/mfaEnable endpoint retrieves an MFA secret key and a token used to associate an authentication application with the authorization server. For more information on codes required to enable MFA, see the Veeam Backup for Google Cloud REST API Reference Overview, section Multi-Factor Authentication.


SecurityBearer 
Request 
path Parameters
name
required
string
Specifies the name of a user 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
recreate
required
boolean
Defines whether you want to recreate the existing MFA secret key (true) or to enable MFA for the user account (false).


 
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/users/{name}/mfaEnable
Request samples 
application/json
{
  • "recreate": true
}
Response samples 
application/json
{
  • "response": {
    },
  • "issues": [
    ]
}
Enable MFA for User Account
The HTTP POST request to the /users/{name}/mfaAccepted endpoint associates an authentication application with the authorization server. 
 For more information on how to enable MFA for a user account, see the Veeam Backup for Google Cloud REST API Reference Overview, section Multi-Factor Authentication.


SecurityBearer 
Request 
path Parameters
name
required
string
Specifies the name of a user 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
code
required
string
Six-digit verification code generated by an authentication application on the trusted device.


 
token
required
string
Token used to associate the authenticator application with the authorization server. Must be received in the Get MFA Secret Key request.


 
Responses 
201
MFA Enabled


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/users/{name}/mfaAccepted
Request samples 
application/json
{
  • "code": "string",
  • "token": "string"
}
Response samples 
application/json
{
  • "success": true,
  • "issues": [
    ]
}
Change Password of User Account
The HTTP POST request to the /users/{name}/changePassword endpoint sets a new password for the specified user account.


SecurityBearer 
Request 
path Parameters
name
required
string
Specifies the name of a user 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
password
required
string
Specifies a new password for the backup account.


 
oldPassword
required
string
Specifies the current password of the backup account.


 
Responses 
201
Password Changed


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/users/{name}/changePassword
Request samples 
application/json
{
  • "password": "string",
  • "oldPassword": "string"
}
Response samples 
application/json
{
  • "user": {
    },
  • "issues": [
    ]
}
Get User Roles
The HTTP GET request to the /users/roles endpoint retrieves a list of all user roles available in 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.


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

    
    

                                

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