Prism Centrals

The /prismCentrals resource collection represents all Nutanix AHV Prism Centrals connected to the backup server and VMs residing in the clusters registered with those Prism Centrals.

Get Collection of Nutanix AHV Prism Centrals

The HTTP GET request to the /prismCentrals endpoint retrieves information on Nutanix AHV Prism Centrals to which Veeam Plug-in for Nutanix AHV 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/v8/prismCentrals

Request samples

curl
Python
JavaScript
C#
Go

Response samples

application/json

[{"settings": {"description": "string",
"address": "string",
"port": 65535,
"certificateThumbprint": "string",
"credentialsTag": "string"
},
"state": "Unknown",
"version": "string"
}
]

Add New Nutanix AHV Prism Central

The HTTP POST request to the /prismCentrals endpoint adds a Nutanix AHV Prism Central to the Veeam Backup & Replication configuration database.

SecurityBearer

Request

Request Body schema: application/json
required

Prism Central Data Object

description	string Description of the Prism Central
address	string IP address or hostname of the Prism Central
port	integer <int32> [ 0 .. 65535 ] Port used to access the Prism Central
userName write-only	string or null Username of an administrator account used to access the Prism Central
password write-only	string or null <password> Password of an administrator account used to access the Prism Central
certificateThumbprint	string or null Certificate thumbprint
credentialsTag	string or null ID of credentials added to the Credentials Manager in Veeam Backup & Replication.

Responses

201

Created

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/v8/prismCentrals

Request samples

application/json

{"description": "string",
"address": "string",
"port": 65535,
"userName": "string",
"password": "pa$$word",
"certificateThumbprint": "string",
"credentialsTag": "string"
}

Response samples

application/json

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

Get Prism Central Data

The HTTP GET request to the /prismCentrals/{id} endpoint retrieves information on a Nutanix AHV Prism Central with the specified ID.

SecurityBearer

Request

path Parameters

required

string

Specifies the ID assigned to a Prism Central in the Nutanix AHV environment. To learn the ID, get a collection of Prism Centrals to which Veeam Plug-in for Nutanix AHV 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/v8/prismCentrals/{id}

Request samples

curl
Python
JavaScript
C#
Go

Response samples

application/json

{"settings": {"description": "string",
"address": "string",
"port": 65535,
"certificateThumbprint": "string",
"credentialsTag": "string"
},
"state": "Unknown",
"version": "string"
}

Modify Nutanix AHV Prism Central Settings

The HTTP PUT request to the /prismCentrals/{id} endpoint updates settings of a Prism Central with the specified ID added to the Veeam Backup & Replication configuration database.

SecurityBearer

Request

path Parameters

required

string

Specifies the ID assigned to a Prism Central in the Nutanix AHV environment. To learn the ID, get a collection of Prism Centrals to which Veeam Plug-in for Nutanix AHV has access.

Request Body schema: application/json
required

Prism Central Data Object

description	string Description of the Prism Central
address	string IP address or hostname of the Prism Central
port	integer <int32> [ 0 .. 65535 ] Port used to access the Prism Central
userName write-only	string or null Username of an administrator account used to access the Prism Central
password write-only	string or null <password> Password of an administrator account used to access the Prism Central
certificateThumbprint	string or null Certificate thumbprint
credentialsTag	string or null ID of credentials added to the Credentials Manager in Veeam Backup & Replication.

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.

put/api/v8/prismCentrals/{id}

Request samples

application/json

{"description": "string",
"address": "string",
"port": 65535,
"userName": "string",
"password": "pa$$word",
"certificateThumbprint": "string",
"credentialsTag": "string"
}

Response samples

application/json

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

Remove Nutanix AHV Prism Central

The HTTP DELETE request to the /prismCentrals/{id} endpoint removes a Nutanix AHV Prism Central with the specified ID from the Veeam Backup & Replication configuration database.

SecurityBearer

Request

path Parameters

required

string

Specifies the ID assigned to a Prism Central in the Nutanix AHV environment. To learn the ID, get a collection of Prism Centrals to which Veeam Plug-in for Nutanix AHV 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.

delete/api/v8/prismCentrals/{id}

Request samples

curl
Python
JavaScript
C#
Go

Response samples

application/json

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

Rescan Prism Central

The HTTP POST request to the /prismCentrals/{id}/refreshAsync endpoint runs the infrastructure rescan operation for entities that belong to a Prism Central with the specified ID.

SecurityBearer

Request

path Parameters

required

string

Specifies the ID assigned to a Prism Central in the Nutanix AHV environment. To learn the ID, get a collection of Prism Centrals to which Veeam Plug-in for Nutanix AHV 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/v8/prismCentrals/{id}/refreshAsync

Request samples

curl
Python
JavaScript
C#
Go

Response samples

application/json

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

Get Collection of Virtual Machines

The HTTP POST request to the prismCentrals/{id}/vms endpoint retrieves a list of all virtual machines residing on the clusters manged by a Prism Central with the specified ID.

SecurityBearer

Request

path Parameters

required

string

Specifies the ID assigned to a Prism Central in the Nutanix AHV environment. To learn the ID, get a collection of Prism Centrals to which Veeam Plug-in for Nutanix AHV 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 Plug-in 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 Plug-in 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/v8/prismCentrals/{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"
}
]
}

Get Collection of Protection Domains

The HTTP GET requests to the /prismCentrals/{id}/protectionDomains endpoint retrieves a list of all protection domains configured in the Prism Central clusters.

SecurityBearer

Request

path Parameters

required

string

Specifies the ID assigned to a Prism Central in the Nutanix AHV environment. To learn the ID, get a collection of Prism Centrals to which Veeam Plug-in for Nutanix AHV 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 Plug-in 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 Plug-in 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/v8/prismCentrals/{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
}
]
}

Get Collection of Volume Groups

The HTTP GET requests to the /prismCentrals/{id}/protectionDomains endpoint retrieves a list of all volume groups configured in the Prism Central clusters.

SecurityBearer

Request

path Parameters

required

string

Specifies the ID assigned to a Prism Central in the Nutanix AHV environment. To learn the ID, get a collection of Prism Centrals to which Veeam Plug-in for Nutanix AHV 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 Plug-in 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 Plug-in 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/v8/prismCentrals/{id}/volumeGroups

Request samples

curl
Python
JavaScript
C#
Go

Response samples

application/json

{"offset": 0,
"limit": 0,
"totalCount": 0,
"results": [{"id": "string",
"clusterId": "string",
"name": "string",
"protectionDomain": "string",
"consistencyGroup": "string"
}
]
}

Get Collection of Prism Central Categories

The HTTP GET request to the /prismCentrals/{id}/categories endpoint retrieves a list of all categories configured in a Prism Central with the specified ID.

SecurityBearer

Request

path Parameters

required

string

Specifies the ID assigned to a Prism Central in the Nutanix AHV environment. To learn the ID, get a collection of Prism Centrals to which Veeam Plug-in for Nutanix AHV 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 Plug-in 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 Plug-in 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/v8/prismCentrals/{id}/categories

Request samples

curl
Python
JavaScript
C#
Go

Response samples

application/json

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

Prism Centrals

Get Collection of Nutanix AHV Prism Centrals

Add New Nutanix AHV Prism Central

Request Body schema: application/jsonrequired

Get Prism Central Data

path Parameters

Modify Nutanix AHV Prism Central Settings

path Parameters

Request Body schema: application/jsonrequired

Remove Nutanix AHV Prism Central

path Parameters

Rescan Prism Central

path Parameters

Get Collection of Virtual Machines

path Parameters

query Parameters

Get Collection of Protection Domains

path Parameters

query Parameters

Get Collection of Volume Groups

path Parameters

query Parameters

Get Collection of Prism Central Categories

path Parameters

query Parameters

Request Body schema: application/json
required

Request Body schema: application/json
required