- 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 /backupServer resource collection represents the backup server settings and all backup repositories to which the backup appliance has access.
Get Backup Server Data
The HTTP GET request to the /backupServer endpoint retrieves information on the Veeam Backup & Replication server that manages the backup appliance.
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
No Backup Server Found
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
- 404
- 500
{- "address": "string",
- "port": 65535,
- "repositoriesCount": 0,
- "state": "Unknown",
- "version": "string"
}Get Collection of Backup Repositories
The HTTP GET request to the /repositories endpoint retrieves a list of backup repositories to which the backup appliance has access.
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. |
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
Not Found. One or more resources specified in the request could not be found in the specified resource collection.
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
- 404
- 500
{- "offset": 0,
- "limit": 0,
- "totalCount": 0,
- "results": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "totalSpace": 0,
- "freeSpace": 0,
- "usedSpace": 0
}
]
}Get Backup Repository Data
The HTTP GET request to the /repositories/{id} endpoint retrieves information on a backup repository with the specified ID.
path Parameters
| id required | string <uuid> Specifies the ID assigned to a backup repository in Veeam Backup for Nutanix AHV. |
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
No Backup Server Found
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
- 404
- 500
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "totalSpace": 0,
- "freeSpace": 0,
- "usedSpace": 0
}Rescan Nutanix AHV Backups
The HTTP POST request to the /backupServer/rescanBackups endpoint allows you to scan Veeam Backup & Replication repositories and to update information on available Nutanix AHV backups in the backup appliance configuration database.
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
No Backup Server Found
Conflict. The request could not be processed. Another task is in progress.
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
- 202
- 400
- 401
- 403
- 404
- 409
- 500
{- "sessionId": "f6567dd8-e069-418e-8893-7d22fcf12459"
}