- About Veeam Plug-in for Nutanix AHV REST API
- Overview
- Changelog
- Authorization
- Backup Appliance Settings
- Backup Server
- Prism Centrals
- Clusters
- getGet Collection of Clusters
- getGet Cluster Data
- getGet Collection of Virtual Machines
- postInfrastructure Rescan for Virtual Machines
- getGet Virtual Machine Data
- getGet Collection of Protection Domains
- postInfrastructure Rescan for Protection Domains
- getGet Collection of Networks
- getGet Collection of Storage Containers
- getGet Collection of Cluster Hosts
- getGet Collection of Volume Groups in Cluster
- getGet Volume Group Data
- postInfrastructure Rescan for Volume Groups
- postCluster Rescan for Snapshots
- Dashboard
- getGet Resource Usage Statistics
- getGet Session Status Statistics for Last 24 Hours
- getGet Job Type Statistics
- getGet Number of Protected VMs
- getGet Collection of Unprotected VMs
- getGet Collection of Protected VMs
- getGet Collection of Recent Job Sessions Duration
- getGet Collection of Available Backup Repositories
- Jobs
- Monitoring
- Protected VMs
- Restore Points
- getGet VM Restore Points
- getGet Restore Point Data
- delDelete Restore Point
- getGet Protection Domain Snapshot Data
- getGet Backup Snapshot Data
- getGet User Snapshot Data
- getGet Backup Data
- postPerform VM Restore
- postPerform Disk Restore
- getGet Collection of Disks From Restore Point
- getGet Collection of Network Adapters From Restore Point
- Sessions
- SMTP Account
- Time Zones
- User Accounts
- Workers
- Virtual Machines
The /virtualMachines resource collection represents all VMs in the Nutanix AHV environment that can be protected by Veeam Backup for Nutanix AHV.
Get Virtual Machines Job Info
The HTTP GET request to the /virtualMachines/jobInfo endpoint retrieves a list of all VMs in the Nutanix AHV environment and number of backup and snapshot jobs protecting each VM.
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. |
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
{- "offset": 0,
- "limit": 0,
- "totalCount": 0,
- "results": [
- {
- "vmId": "string",
- "vmName": "string",
- "vmSize": 0,
- "clusterId": "string",
- "clusterName": "string",
- "snapshotJobsCount": 0,
- "backupJobsCount": 0
}
]
}Get VM Jobs
The HTTP GET request to the /virtualMachines/{clusterId}/{vmId}/jobs endpoint retrieves a list of all backup and snapshot jobs of a VM with the specified ID.
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. |
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
{- "offset": 0,
- "limit": 0,
- "totalCount": 0,
- "results": [
- {
- "jobId": "string",
- "jobName": "string",
- "jobMode": "Unknown"
}
]
}Protect VMs
The HTTP POST request to the /virtualMachines/addToJob endpoint allows you to include resources with the specified IDs into the backup scope.
Request Body schema: application/jsonrequired
required | Array of objects Virtual machines to be included into the job. |
| jobId required | string System ID assigned to the job that will protect the resources. PD snapshot jobs are not supported. |
No Content
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
{- "objects": [
- {
- "id": "string",
- "clusterId": "string"
}
], - "jobId": "string"
}- 400
- 401
- 403
- 500
{- "type": "string",
- "title": "string",
- "status": 0,
- "detail": "string",
- "instance": "string",
- "extensions": {
- "property1": { },
- "property2": { }
}
}