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

Restore Points

The /restorePoints resource collection represents all restore points created for VMs and PDs with Veeam Backup for Nutanix AHV.

Get VM Restore Points

The HTTP GET request to the /restorePoints endpoint retrieves a list of all restore points of a VM in Veeam Backup for Nutanix AHV.

SecurityBearer
Request
query Parameters
clusterId
string or null

ID assigned to a cluster in the Nutanix AHV environment.

vmId
string or null

ID assigned to a protected VM in the Nutanix AHV environment.

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/restorePoints
Request samples 
Response samples 
application/json
{
  • "offset": 0,
  • "limit": 0,
  • "totalCount": 0,
  • "results": [
    ]
}
Get Restore Point Data
The HTTP GET request to the /restorePoints/{id} endpoint retrieves information on a restore point with the specified ID.


SecurityBearer 
Request 
path Parameters
id
required
string
System ID assigned to a restore point in Veeam Backup and Replication.


 
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/restorePoints/{id}
Request samples 
Response samples 
application/json
{
  • "id": "string",
  • "type": "Unknown",
  • "creationTimeUtc": "2019-08-24T14:15:22Z",
  • "jobId": "string",
  • "jobName": "string"
}
Delete Restore Point
The HTTP DELETE request to the /restorePoints/{id}/delete endpoint deletes a restore point with the specified ID.


SecurityBearer 
Request 
path Parameters
id
required
string
System ID assigned to a restore point in Veeam Backup and Replication.


 
query Parameters
deleteFromServer
boolean
 Default:  false
Defines whether backup files will be deleted from backup repositories.


 
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/restorePoints/{id}/delete
Request samples 
Response samples 
application/problem+json
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "extensions": {
    }
}
Get Protection Domain Snapshot Data
The HTTP GET request to the /restorePoints/protectionDomainSnapshots/{id} endpoint retrieves information on a protection domain snapshot with the specified ID.


SecurityBearer 
Request 
path Parameters
id
required
string
System ID assigned to a protection domain snapshot in Nutanix AHV environment.


 
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/restorePoints/protectionDomainSnapshots/{id}
Request samples 
Response samples 
application/json
{
  • "id": "string",
  • "type": "Unknown",
  • "creationTimeUtc": "2019-08-24T14:15:22Z",
  • "jobId": "string",
  • "jobName": "string",
  • "snapshotId": "string",
  • "pdName": "string",
  • "vmIds": [
    ]
}
Get Backup Snapshot Data
The HTTP GET request to the /restorePoints/backupSnapshots/{id} endpoint retrieves information on a backup snapshot with the specified ID.


SecurityBearer 
Request 
path Parameters
id
required
string
System ID assigned to a backup snapshot in Veeam Backup and Replication.


 
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/restorePoints/backupSnapshots/{id}
Request samples 
Response samples 
application/json
{
  • "id": "string",
  • "type": "Unknown",
  • "creationTimeUtc": "2019-08-24T14:15:22Z",
  • "jobId": "string",
  • "jobName": "string",
  • "snapshotName": "string",
  • "snapshotType": "Unknown",
  • "vmId": "string"
}
Get User Snapshot Data
The HTTP GET request to the /restorePoints/userSnapshots/{id} endpoint retrieves information on a user snapshot with the specified ID.


SecurityBearer 
Request 
path Parameters
id
required
string
System ID assigned to a user snapshot in Nutanix AHV environment.


 
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/restorePoints/userSnapshots/{id}
Request samples 
Response samples 
application/json
{
  • "id": "string",
  • "type": "Unknown",
  • "creationTimeUtc": "2019-08-24T14:15:22Z",
  • "jobId": "string",
  • "jobName": "string",
  • "snapshotName": "string",
  • "vmId": "string"
}
Get Backup Data
The HTTP GET request to the /restorePoints/backups/{id} endpoint retrieves information on a backup with the specified ID.


SecurityBearer 
Request 
path Parameters
id
required
string
System ID assigned to a restore point in Veeam Backup and Replication.


 
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/restorePoints/backups/{id}
Request samples 
Response samples 
application/json
{
  • "id": "string",
  • "type": "Unknown",
  • "creationTimeUtc": "2019-08-24T14:15:22Z",
  • "jobId": "string",
  • "jobName": "string",
  • "isCorrupted": true,
  • "backupSnapshotId": "string",
  • "vmId": "string",
  • "backupId": "eb7cea43-10b2-42dd-8819-ab9aed37565f"
}
Perform VM Restore
The HTTP POST request to the /restorePoints/restore endpoint performs restore of an entire VM from a restore point.


SecurityBearer 
Request 
Request Body schema: application/json
required
sourceVmId
required
string
ID assigned to the source VM that is being restored.


 
restorePointId
required
string
System ID assigned to the restore point in Veeam Backup and Replication.


 
targetVmClusterId
string or null
ID assigned to a cluster where the restored VM will reside.


 
targetVmName
string or null
New name of the restored VM.


 
restoreToOriginal
boolean
Defines whether the VM will be restored to the original location.


 
storageContainerId
string or null
ID assigned to a storage container assigned in the Nutanix AHV environment.


 
Array of objects or null (NetworkAdapterRemap) 
Network adapter configuration of the restored VM.


 
powerOnVmAfterRestore
boolean
Defines whether the VM will be powered on after restore.


 
disconnectNetworksAfterRestore
boolean
Defines whether all network adapters will be disconnected from their networks after restore.


 
reason
string or null
Reason for restore.


 
restoreVmCategories
boolean
Defines whether VM categories will be restored.


 
Responses 
202
Accepted


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/restorePoints/restore
Request samples 
application/json
{
  • "sourceVmId": "string",
  • "targetVmClusterId": "string",
  • "targetVmName": "string",
  • "restoreToOriginal": true,
  • "restorePointId": "string",
  • "storageContainerId": "string",
  • "networkAdapters": [
    ],
  • "powerOnVmAfterRestore": true,
  • "disconnectNetworksAfterRestore": true,
  • "reason": "string",
  • "restoreVmCategories": true
}
Response samples 
application/json
{
  • "sessionId": "f6567dd8-e069-418e-8893-7d22fcf12459"
}
Perform Disk Restore
The HTTP POST request to the /restorePoints/diskRestore endpoint performs restore of disks using the specified restore settings.


SecurityBearer 
Request 
Request Body schema: application/json
required
sourceVmId
required
string
ID of a source VM to restore from.


 
targetVmId
required
string
ID of a target VM to restore to.


 
restorePointId
required
string
System ID assigned to the restore point in Veeam Backup and Replication.


 
required
Array of objects (DiskSettingsForRestore) 
List of disk settings to restore (used only for disk restore)


 
targetVmClusterId
string or null
ID of a target Cluster to restore to.


 
powerOnVmAfterRestore
boolean
Defines whether the VM will be powered on after restore.


 
reason
string or null
Reason for restore.


 
Responses 
202
Accepted


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/restorePoints/diskRestore
Request samples 
application/json
{
  • "sourceVmId": "string",
  • "targetVmId": "string",
  • "targetVmClusterId": "string",
  • "restorePointId": "string",
  • "diskSettings": [
    ],
  • "powerOnVmAfterRestore": true,
  • "reason": "string"
}
Response samples 
application/json
{
  • "sessionId": "f6567dd8-e069-418e-8893-7d22fcf12459"
}
Get Collection of Disks From Restore Point
The HTTP GET request to the /restorePoints/{id}/disks endpoint retrieves a list of disks from the specified VM restore point.


SecurityBearer 
Request 
path Parameters
id
required
string
System ID assigned to a restore point in Veeam Backup and Replication.


 
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/restorePoints/{id}/disks
Request samples 
Response samples 
application/json
[
  • {
    }
]
Get Collection of Network Adapters From Restore Point
The HTTP GET request to the /restorePoints/{id}/networkAdapters endpoint retrieves a list of network adapters from metadata of a restore point with the specified ID. The information can be provided for backups and backup snapshot only.


SecurityBearer 
Request 
path Parameters
id
required
string
System ID assigned to a restore point in Veeam Backup and Replication.


 
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/restorePoints/{id}/networkAdapters
Request samples 
Response samples 
application/json
[
  • {
    }
]

    
    

                                

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