Protected VMs

The /protectedVms resource collection represents all VMs protected with Veeam Backup for Nutanix AHV.

Get Collection of Protected VMs

The HTTP GET request to the /protectedVms endpoint retrieves a list of all VMs that are protected with Veeam Backup for Nutanix AHV.

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 Parameters.

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

Get VM Restore Points

The HTTP GET request to the /protectedVms/{clusterId}/{vmId}/restorePoints endpoint retrieves a list of all restore points of a VM with the specified ID.

SecurityBearer
Request
path Parameters
clusterId
required
string

Specifies the system ID assigned to a cluster in the Nutanix AHV environment.

vmId
required
string

Specifies the system ID assigned to a VM in the Nutanix AHV environment.

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 Parameters.

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/protectedVms/{clusterId}/{vmId}/restorePoints
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