- About Veeam Plug-in for Nutanix AHV REST API
- Overview
- Changelog
- Prism Centrals
- getGet Collection of Nutanix AHV Prism Centrals
- postAdd New Nutanix AHV Prism Central
- getGet Prism Central Data
- putModify Nutanix AHV Prism Central Settings
- delRemove Nutanix AHV Prism Central
- postRescan Prism Central
- getGet Collection of Virtual Machines
- getGet Collection of Protection Domains
- getGet Collection of Volume Groups
- getGet Collection of Prism Central Categories
- Clusters
- getGet Collection of Clusters
- postAdd New Cluster
- getGet Cluster Data
- delRemove Cluster
- postInfrastructure Rescan for Cluster
- getGet Cluster Connection Settings
- putModify Cluster Settings
- getGet Collection of Virtual Machines
- getGet Collection of Protection Domains
- getGet Collection of Networks
- getGet Collection of Storage Containers
- getGet Collection of Cluster Hosts
- getGet Collection of Volume Groups in Cluster
- Jobs
- Restore Points
- Sessions
- Workers
The /restorePoints resource collection represents all restore points created for VMs and PDs with Veeam Plug-in for Nutanix AHV.
Perform VM Restore
The HTTP POST request to the /restorePoints/restore endpoint performs restore of an entire VM from a restore point.
Request Body schema: application/jsonrequired
| restorePointId required | string System ID assigned to the restore point in Veeam Backup and Replication. |
| sourceVmId | string or null ID assigned to a source VM from the PD snapshot that is being restored. The field is only required for PD snapshots. |
| 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. |
| reason | string or null Reason for restore. |
| restoreVmCategories | boolean Defines whether VM categories will be restored. |
Accepted
Bad Request. The request body is malformed, incomplete or otherwise invalid.
Unauthorized. The authorization header has been expected but not found (or found but is expired).
Forbidden. The user sending a request does not have adequate privileges to access one or more objects specified in the request.
Internal Server Error. The request has been received but could not be completed because of an internal error at the server side.
- Payload
- curl
- Python
- JavaScript
- C#
- Go
{- "sourceVmId": "string",
- "targetVmClusterId": "string",
- "targetVmName": "string",
- "restoreToOriginal": true,
- "restorePointId": "string",
- "storageContainerId": "string",
- "networkAdapters": [
- {
- "value": {
- "networkId": "string",
- "ipAddresses": [
- "string"
], - "macAddress": "string"
}
}
], - "powerOnVmAfterRestore": true,
- "reason": "string",
- "restoreVmCategories": true
}- 202
- 400
- 401
- 403
- 500
{- "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.
Request Body schema: application/jsonrequired
| restorePointId required | string System ID assigned to the restore point in Veeam Backup and Replication. |
required | Array of objects (DiskSettingsForRestore) non-empty List of disk settings to restore (used only for disk restore) |
| targetVmId | string or null ID of a target VM to restore to. |
| 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. |
Accepted
Bad Request. The request body is malformed, incomplete or otherwise invalid.
Unauthorized. The authorization header has been expected but not found (or found but is expired).
Forbidden. The user sending a request does not have adequate privileges to access one or more objects specified in the request.
Internal Server Error. The request has been received but could not be completed because of an internal error at the server side.
- Payload
- curl
- Python
- JavaScript
- C#
- Go
{- "targetVmId": "string",
- "targetVmClusterId": "string",
- "restorePointId": "string",
- "diskSettings": [
- {
- "diskId": "string",
- "busType": "Unknown",
- "index": 0,
- "storageContainerId": "string"
}
], - "powerOnVmAfterRestore": true,
- "reason": "string"
}- 202
- 400
- 401
- 403
- 500
{- "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.
path Parameters
| id required | string System ID assigned to a restore point in Veeam Backup and Replication. |
OK
Bad Request. The request body is malformed, incomplete or otherwise invalid.
Unauthorized. The authorization header has been expected but not found (or found but is expired).
Forbidden. The user sending a request does not have adequate privileges to access one or more objects specified in the request.
Internal Server Error. The request has been received but could not be completed because of an internal error at the server side.
- curl
- Python
- JavaScript
- C#
- Go
- 200
- 400
- 401
- 403
- 500
[- {
- "id": "string",
- "busType": "Unknown",
- "index": 0,
- "diskLabel": "string",
- "isCdrom": true,
- "isVolumeGroup": true,
- "size": 0,
- "storageContainerId": "string",
- "storageContainerName": "string"
}
]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.
path Parameters
| id required | string System ID assigned to a restore point in Veeam Backup and Replication. |
OK
Bad Request. The request body is malformed, incomplete or otherwise invalid.
Unauthorized. The authorization header has been expected but not found (or found but is expired).
Forbidden. The user sending a request does not have adequate privileges to access one or more objects specified in the request.
Internal Server Error. The request has been received but could not be completed because of an internal error at the server side.
- curl
- Python
- JavaScript
- C#
- Go
- 200
- 400
- 401
- 403
- 500
[- {
- "id": "string",
- "networkId": "string",
- "networkName": "string",
- "ipAddresses": [
- "string"
], - "macAddress": "string"
}
]