Veeam Plug-in for Nutanix AHV 7 [Archived]
REST API Reference
Related documents

User Accounts

The /account resource collection represents all user accounts created in Veeam Backup for Nutanix AHV.

Change User Password

The HTTP POST request to the /account/{id}/changePassword endpoint updates the password of a specific user.

SecurityBearer
Request
path Parameters
id
required
string <uuid>

ID assigned to the Veeam Backup for Nutanix AHV user account.

Request Body schema: application/json
required
newPassword
string <password> <= 255 characters

New user password.

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.

post/api/v7/account/{id}/changePassword
Request samples
application/json
{
  • "newPassword": "pa$$word"
}
Response samples
application/problem+json
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "extensions": {
    }
}

Change Password of Current User

The HTTP POST request to the /account/changePassword endpoint updates the password of the current user. After the password is changed, the user must obtain a new access token.

SecurityBearer
Request
Request Body schema: application/json
required
oldPassword
string <password> <= 255 characters

Current password.

newPassword
string <password> <= 255 characters

New password.

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.

post/api/v7/account/changePassword
Request samples
application/json
{
  • "oldPassword": "pa$$word",
  • "newPassword": "pa$$word"
}
Response samples
application/problem+json
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "extensions": {
    }
}

Get User Account Data

The HTTP GET request to the /account/{id} endpoint retrieves information on a specific user.

SecurityBearer
Request
path Parameters
id
required
string <uuid>

ID assigned to the Veeam Backup for Nutanix AHV 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.

get/api/v7/account/{id}
Request samples 
Response samples 
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "username": "string",
  • "description": "string",
  • "role": "Unknown"
}
Update User Account
The HTTP PUT request to the /account/{id} endpoint updates user role and description for a specific user account.
 
NOTE 
 To change the user password, use the Change User Password endpoint.


SecurityBearer 
Request 
path Parameters
id
required
string <uuid> 
ID assigned to the Veeam Backup for Nutanix AHV user account.


 
Request Body schema: application/json
required
role
required
string (UserRole) 
Role assigned to the user. Defines user permissions in Veeam Backup for Nutanix AHV.


 Enum: "Unknown" "PortalAdministrator" "PortalOperator" "RestoreOperator"  
description
required
string
Description of the user account.


 
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.


put/api/v7/account/{id}
Request samples 
application/json
{
  • "role": "Unknown",
  • "description": "string"
}
Response samples 
application/problem+json
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "extensions": {
    }
}
Remove User Account
The HTTP DELETE request to the /account/{id} endpoint deletes a specific user account.


SecurityBearer 
Request 
path Parameters
id
required
string <uuid> 
ID assigned to the Veeam Backup for Nutanix AHV user account.


 
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/v7/account/{id}
Request samples 
Response samples 
application/problem+json
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "extensions": {
    }
}
Add User Account
The HTTP POST request to the /account endpoint adds a new user account to Veeam Backup for Nutanix AHV.


SecurityBearer 
Request 
Request Body schema: application/json
required
username
required
string
Name of a Veeam Backup for Nutanix AHV user must start with a lowercase letter and can contain only the following characters:  a-z, 0-9, _ and -. The name must not match Linux system user names (such as root, daemon). The maximum length of the username is 32 characters.


 
password
required
string <password> 
User password.


 
role
required
string (UserRole) 
Role assigned to the user. Defines user permissions in Veeam Backup for Nutanix AHV.


 Enum: "Unknown" "PortalAdministrator" "PortalOperator" "RestoreOperator"  
description
string
User account description.


 
Responses 
201
Created


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/v7/account
Request samples 
application/json
{
  • "role": "Unknown",
  • "username": "string",
  • "description": "string",
  • "password": "pa$$word"
}
Response samples 
application/problem+json
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "extensions": {
    }
}
Get Collection of User Accounts
The HTTP GET request to the /account endpoint returns a list of all created Veeam Backup for Nutanix AHV user accounts.


SecurityBearer 
Request 
query Parameters
offset
integer <int32>   >= 0 
 Default:  0
Excludes from a response the first N items of a resource collection.


 
limit
integer <int32>   >= -1 
 Default:  100
Specifies the maximum number of items of a resource collection to return in a response.


 
write-only
Array of objects or null (FilterParameter) 
Specifies the criteria for items to be returned in a response. For more information, see the Veeam Backup for Nutanix AHV REST API Reference Overview, section Filter Parameters.


 
write-only
Array of objects or null (SortParameter) 
Specifies the order of items in the response. For more information, see the Veeam Backup for Nutanix AHV REST API Reference Overview, section Sort Parameter.


 
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/v7/account
Request samples 
Response samples 
application/json
{
  • "offset": 0,
  • "limit": 0,
  • "totalCount": 0,
  • "results": [
    ]
}

    
    

                                

                                    
Document updated 9/03/2025
Page content applies to build 12.7.1.12