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

Dashboard

The /dashboard resource collection allows you to get summary of Veeam Backup for Nutanix AHV statistics.

Get Resource Usage Statistics

The HTTP GET request to the /dashboard/systemMonitoringInfo endpoint retrieves CPU utilization, RAM consumption and storage usage on the backup appliance.

SecurityBearer
Request
query Parameters
metricType
required
Array of strings (SystemMetricType)

Returns only data on resources of the specified types.

Items Enum: "Cpu" "Memory" "Storage"
from
string or null <date-time>

Returns only data after the specified date and time.

to
string or null <date-time>

Returns only data before the specified date and time.

reportInterval
string or null <time-span>

Returns data for periods defined by the specified time interval. By default, the interval equals 30 minutes.

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/dashboard/systemMonitoringInfo
Request samples 
Response samples 
application/json
{
  • "cpuUsageInfo": [
    ],
  • "memoryUsageInfo": [
    ],
  • "storageUsageInfo": [
    ]
}
Get Session Status Statistics for Last 24 Hours
The HTTP GET request to the /dashboard/sessionsSummary endpoint retrieves a number of sessions started for data protection or disaster recovery operations during the past 24 hours that completed successfully, a number of sessions that completed with warnings, a number of sessions that completed with errors, and a number of sessions that are currently running.


SecurityBearer 
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/dashboard/sessionsSummary
Request samples 
Response samples 
application/json
{
  • "sessionsError": 0,
  • "sessionsErrorDifference": "NotChanged",
  • "sessionsWarning": 0,
  • "sessionsWarningDifference": "NotChanged",
  • "sessionsSuccess": 0,
  • "sessionsSuccessDifference": "NotChanged",
  • "sessionsRunning": 0,
  • "sessionsRunningDifference": "NotChanged"
}
Get Job Type Statistics
The HTTP GET request to the /dashboard/sessionRatio endpoint retrieves a total number of job sessions and a number of successfully completed sessions during the specified period. The statistics is provided for each type of job: backup, snapshot and PD snapshot.


SecurityBearer 
Request 
query Parameters
period
write-only
required
string (ReportPeriod) 
Specifies the period to collect the statistics.


 Enum: "Day" "Week" "Month"  
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/dashboard/sessionRatio
Request samples 
Response samples 
application/json
{
  • "backups": 0,
  • "backupsTotal": 0,
  • "snapshots": 0,
  • "snapshotsTotal": 0,
  • "pdSnapshots": 0,
  • "pdSnapshotsTotal": 0
}
Get Number of Protected VMs
The HTTP GET request to the /dashboard/protectedVms endpoint retrieves the number of VMs included into snapshot jobs only, the number of VMs included into backup jobs and the number of unprotected VMs.


SecurityBearer 
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/dashboard/protectedVms
Request samples 
Response samples 
application/json
{
  • "totalVms": 0,
  • "protectedVms": 0,
  • "protectedVmsWithSnapshots": 0,
  • "unprotectedVms": 0
}
Get Collection of Unprotected VMs
The HTTP GET request to the /dashboard/unprotectedVmsInCluster endpoint retrieves a list of all unprotected VMs.


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/dashboard/unprotectedVmsInCluster
Request samples 
Response samples 
application/json
{
  • "offset": 0,
  • "limit": 0,
  • "totalCount": 0,
  • "results": [
    ]
}
Get Collection of Protected VMs
The HTTP GET request to the /dashboard/protectedVmsInCluster endpoint retrieves a list of all protected VMs.


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/dashboard/protectedVmsInCluster
Request samples 
Response samples 
application/json
{
  • "offset": 0,
  • "limit": 0,
  • "totalCount": 0,
  • "results": [
    ]
}
Get Collection of Recent Job Sessions Duration
The HTTP GET request to the /dashboard/topJobsDuration endpoint retrieves duration statistics for recent sessions of the specified job type.


SecurityBearer 
Request 
query Parameters
jobMode
required
string (JobMode) 
Specifies a job type.


 Enum: "Unknown" "Backup" "Snapshot" "PdSnapshot"  
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/dashboard/topJobsDuration
Request samples 
Response samples 
application/json
{
  • "offset": 0,
  • "limit": 0,
  • "totalCount": 0,
  • "results": [
    ]
}
Get Collection of Available Backup Repositories
The HTTP GET request to the dashboard/backupRepositories endpoint retrieves a list of available backup repositories.


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/dashboard/backupRepositories
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