Clusters

The /clusters resource collection represents all clusters connected to the backup server and VMs residing on those clusters.

Get Collection of Clusters

The HTTP GET request to the /clusters endpoint retrieves information on clusters to which the backup appliance has access.

SecurityBearer

Responses

200

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/clusters

Request samples

curl
Python
JavaScript
C#
Go

Response samples

application/json

[{"id": "string",
"prismCentralId": "string",
"name": "string",
"description": "string",
"address": "string",
"port": 65535,
"state": "Unknown",
"version": "string"
}
]

Get Cluster Data

The HTTP GET request to the /clusters/{id} endpoint retrieves information on a cluster with the specified ID.

SecurityBearer

Request

path Parameters

required

string

Specifies the ID assigned to a cluster in the Nutanix AHV environment. To learn the ID, get a collection of clusters to which the backup appliance has access.

Responses

200

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/clusters/{id}

Request samples

curl
Python
JavaScript
C#
Go

Response samples

application/json

{"id": "string",
"prismCentralId": "string",
"name": "string",
"description": "string",
"address": "string",
"port": 65535,
"state": "Unknown",
"version": "string"
}

Get Collection of Virtual Machines

The HTTP GET request to the /virtualMachines endpoint retrieves a list of all virtual machines residing on a specified cluster.

SecurityBearer

Request

path Parameters

required

string

Specifies the ID assigned to a cluster in the Nutanix AHV environment. To learn the ID, get a collection of clusters 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.

Responses

200

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/clusters/{id}/vms

Request samples

curl
Python
JavaScript
C#
Go

Response samples

application/json

{"offset": 0,
"limit": 0,
"totalCount": 0,
"results": [{"id": "string",
"name": "string",
"clusterId": "string",
"clusterName": "string",
"vmSize": 0,
"volumeGroupSize": 0,
"protectionDomain": "string",
"consistencyGroup": "string",
"categories": ["string"
],
"disks": [{"id": "string",
"busType": "Unknown",
"index": 0,
"diskLabel": "string",
"isCdrom": true,
"isVolumeGroup": true,
"size": 0,
"storageContainerId": "string",
"storageContainerName": "string"
}
],
"volumeGroups": ["string"
],
"networkAdapters": [{"id": "string",
"networkId": "string",
"networkName": "string",
"ipAddresses": ["string"
],
"macAddress": "string"
}
],
"guestOsVersion": "string"
}
]
}

Infrastructure Rescan for Virtual Machines

The HTTP POST request to the /clusters/{id}/vms/refreshAsync endpoint runs the infrastructure rescanning operation for virtual machines.

SecurityBearer

Request

path Parameters

required

string

Specifies the ID assigned to a cluster in the Nutanix AHV environment. To learn the ID, get a collection of clusters to which the backup appliance has access.

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/clusters/{id}/vms/refreshAsync

Request samples

curl
Python
JavaScript
C#
Go

Response samples

application/json

{"sessionId": "f6567dd8-e069-418e-8893-7d22fcf12459"
}

Get Virtual Machine Data

The HTTP GET request to the /clusters/{id}/vms/{vmId} endpoint retrieves information on a VM with the specified ID.

SecurityBearer

Request

path Parameters

id required	string Specifies the ID assigned to a cluster in the Nutanix AHV environment. To learn the ID, get a collection of clusters to which the backup appliance has access.
vmId required	string Specifies the ID assigned to a VM that belongs to the specified cluster.

Responses

200

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/clusters/{id}/vms/{vmId}

Request samples

curl
Python
JavaScript
C#
Go

Response samples

application/json

{"id": "string",
"name": "string",
"clusterId": "string",
"clusterName": "string",
"vmSize": 0,
"volumeGroupSize": 0,
"protectionDomain": "string",
"consistencyGroup": "string",
"categories": ["string"
],
"disks": [{"id": "string",
"busType": "Unknown",
"index": 0,
"diskLabel": "string",
"isCdrom": true,
"isVolumeGroup": true,
"size": 0,
"storageContainerId": "string",
"storageContainerName": "string"
}
],
"volumeGroups": ["string"
],
"networkAdapters": [{"id": "string",
"networkId": "string",
"networkName": "string",
"ipAddresses": ["string"
],
"macAddress": "string"
}
],
"guestOsVersion": "string"
}

Get Collection of Protection Domains

The HTTP GET request to the /clusters/{id}/protectionDomains endpoint retrieves a list of all protection domains configured in the specified cluster.

SecurityBearer

Request

path Parameters

required

string

Specifies the ID assigned to a cluster in the Nutanix AHV environment. To learn the ID, get a collection of clusters 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 Parameters.

Responses

200

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/clusters/{id}/protectionDomains

Request samples

curl
Python
JavaScript
C#
Go

Response samples

application/json

{"offset": 0,
"limit": 0,
"totalCount": 0,
"results": [{"name": "string",
"clusterId": "string",
"virtualMachinesSize": 0,
"virtualMachinesCount": 0
}
]
}

Infrastructure Rescan for Protection Domains

The HTTP POST request to the /clusters/{id}/protectionDomains/refresh endpoint runs the infrastructure rescanning operation for protection domains.

SecurityBearer

Request

path Parameters

required

string

Specifies the ID assigned to a cluster in the Nutanix AHV environment. To learn the ID, get a collection of clusters to which the backup appliance has access.

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.

post/api/v7/clusters/{id}/protectionDomains/refresh

Request samples

curl
Python
JavaScript
C#
Go

Response samples

application/problem+json

{"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string",
"extensions": {"property1": { },
"property2": { }
}
}

Get Collection of Networks

The HTTP GET request to the /clusters/{id}/networks endpoint retrieves a list of all networks configured in the specified cluster.

SecurityBearer

Request

path Parameters

required

string

Specifies the ID assigned to a cluster in the Nutanix AHV environment. To learn the ID, get a collection of clusters to which the backup appliance has access.

Responses

200

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/clusters/{id}/networks

Request samples

curl
Python
JavaScript
C#
Go

Response samples

application/json

[{"id": "string",
"name": "string",
"networkAddress": "string",
"ipManagementOn": true,
"prefixLength": 0,
"ipPool": ["string"
],
"gatewayIp": "string"
}
]

Get Collection of Storage Containers

The HTTP GET request to the /clusters/{id}/storageContainers endpoint retrieves a list of all storage containers configured in the specified cluster.

SecurityBearer

Request

path Parameters

required

string

Specifies the ID assigned to a cluster in the Nutanix AHV environment. To learn the ID, get a collection of clusters 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 Parameters.

Responses

200

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/clusters/{id}/storageContainers

Request samples

curl
Python
JavaScript
C#
Go

Response samples

application/json

{"offset": 0,
"limit": 0,
"totalCount": 0,
"results": [{"id": "string",
"name": "string",
"maxCapacity": 0,
"reservedCapacity": 0,
"usedSpace": 0,
"freeSpace": 0
}
]
}

Get Collection of Cluster Hosts

The HTTP GET request to the /clusters/{id}/hosts endpoint retrieves a list of all host configured in the specified cluster.

SecurityBearer

Request

path Parameters

required

string

Specifies the ID assigned to a cluster in the Nutanix AHV environment. To learn the ID, get a collection of clusters 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 Parameters.

Responses

200

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).

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/clusters/{id}/hosts

Request samples

curl
Python
JavaScript
C#
Go

Response samples

application/json

{"offset": 0,
"limit": 0,
"totalCount": 0,
"results": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"cpuUsage": 0,
"memoryUsage": 0,
"diskUsage": 0
}
]
}

Get Collection of Volume Groups in Cluster

The HTTP GET request to the /clusters/{id}/volumeGroups endpoint retrieves a list of all volume groups configured in the specified cluster.

SecurityBearer

Request

path Parameters

required

string

Specifies the ID assigned to a cluster in the Nutanix AHV environment. To learn the ID, get a collection of clusters to which the backup appliance has access.

Responses

200

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/clusters/{id}/volumeGroups

Request samples

curl
Python
JavaScript
C#
Go

Response samples

application/json

[{"id": "string",
"clusterId": "string",
"name": "string",
"protectionDomain": "string",
"consistencyGroup": "string"
}
]

Get Volume Group Data

The HTTP GET request to the /clusters/{id}/volumeGroups/{volumeGroupId} endpoint retrieves information on a volume group in the specified cluster.

SecurityBearer

Request

path Parameters

id required	string Specifies the ID assigned to a cluster in the Nutanix AHV environment. To learn the ID, get a collection of clusters to which the backup appliance has access.
volumeGroupId required	string Specifies the ID assigned to a volume group in the Nutanix AHV environment.

Responses

200

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/clusters/{id}/volumeGroups/{volumeGroupId}

Request samples

curl
Python
JavaScript
C#
Go

Response samples

application/json

{"id": "string",
"clusterId": "string",
"name": "string",
"protectionDomain": "string",
"consistencyGroup": "string"
}

Infrastructure Rescan for Volume Groups

The HTTP POST request to the /clusters/{id}/volumeGroups/refresh endpoint runs the infrastructure rescanning operation for volume groups.

SecurityBearer

Request

path Parameters

required

string

Specifies the ID assigned to a cluster in the Nutanix AHV environment. To learn the ID, get a collection of clusters to which the backup appliance has access.

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.

post/api/v7/clusters/{id}/volumeGroups/refresh

Request samples

curl
Python
JavaScript
C#
Go

Response samples

application/problem+json

{"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string",
"extensions": {"property1": { },
"property2": { }
}
}

Cluster Rescan for Snapshots

The HTTP POST request to the /clusters/{id}/rescanSnapshots endpoint runs the cluster rescanning operation for snapshots. Compatible snapshots are automatically imported.

SecurityBearer

Request

path Parameters

required

string

Specifies the ID assigned to a cluster in the Nutanix AHV environment. To learn the ID, get a collection of clusters to which the backup appliance has access.

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

409

Conflict. The request could not be processed. Another task is in progress.

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/clusters/{id}/rescanSnapshots

Request samples

curl
Python
JavaScript
C#
Go

Response samples

application/json

{"sessionId": "f6567dd8-e069-418e-8893-7d22fcf12459"
}