Hypervisors Controller Resource

The API allows you to list, view, create and edit hypervisors.

GET /hypervisors

Returns list of hypervisors filtered by specified query parameters.

Request Parameters
name type description constraints
backup-to-be-restored query  
direction query  
filter query  
hypervisor-manager query  
nameLike query  
orderBy query  
page query  
size query  
snapshotable query boolean
type query "CITRIX" or "ESXI" or "HYPERV" or "KUBERNETES" or "KVM" or "NUTANIX" or "OPENSHIFT" or "OVM" or "PROXMOX" or "XEN"
Response Body
media type data type description
application/json array of HypervisorListRecord (JSON) list of hypervisors filtered by specified query parameters

Example

Request
GET /hypervisors
Content-Type: */*
Accept: application/json

                
...
                
              
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
[ {
  "host" : "...",
  "sshPort" : 12345,
  "user" : "...",
  "nodeConfig" : {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  },
  "cluster" : {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  },
  "dataCenter" : {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  },
  "vmCount" : 12345,
  "storageType" : "CEPH",
  "licenseCovered" : true,
  "hvManager" : {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  },
  "storageProvider" : {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  },
  "lastInventorySyncDate" : 12345,
  "lastSuccessfulInventorySyncDate" : 12345,
  "possibleActions" : [ "WRITE", "HVM_READ" ],
  "version" : "...",
  "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
  "type" : {
    "name" : "ENUM_NAME",
    "description" : "Enum description"
  }
} ]
                
              

POST /hypervisors

Create hypervisor.

Request Body
media type data type description
application/json HypervisorRequest (JSON) specify details for new hypervisor
Response Body
media type data type description
application/json HypervisorDetails (JSON) details of newly created hypervisor

Example

Request
POST /hypervisors
Content-Type: application/json
Accept: application/json

                
{
  "password" : "...",
  "hvManager" : {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  },
  "cluster" : {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  },
  "dataCenter" : {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  },
  "type" : {
    "name" : "ENUM_NAME",
    "description" : "Enum description"
  },
  "host" : "...",
  "sshPort" : 12345,
  "nodeConfig" : {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  },
  "sshKeyPath" : "...",
  "user" : "...",
  "vmExportImportMode" : "DISK_ATTACHMENT_CHANGED_BLOCK_TRACKING",
  "transferNicAddress" : "...",
  "dataCenterName" : "...",
  "vmOwner" : "...",
  "vmOwningGroup" : "...",
  "storageProvider" : {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  },
  "storageType" : "DEFAULT",
  "licenseCovered" : true,
  "useNetcat" : true,
  "libvirtSettings" : {
    "libvirtSshTimeout" : 12345,
    "libvirtSshKnownHostsPath" : "...",
    "libvirtSshProgressRefreshRate" : 12345,
    "libvirtLvmSnapshotSize" : "...",
    "libvirtLvmSnapshotExtents" : "...",
    "libvirtAlwaysExportFullIfVmTurnedOff" : true
  },
  "citrixSettings" : {
    "citrixExportRefreshRate" : 12345,
    "citrixEnableXvaCompression" : true,
    "citrixSnapshotRemovalTimeout" : 12345
  },
  "proxmoxSettings" : {
    "proxmoxBackupStorage" : "...",
    "proxmoxCompressionType" : "GZIP",
    "proxmoxNbdBufferReleaseMaxAttempts" : 12345,
    "proxmoxNbdBufferReleaseTimeout" : 12345,
    "proxmoxNbdBufferReleaseWaitPeriod" : 12345,
    "proxmoxAvailableNbdWaitPeriod" : 12345,
    "proxmoxConnectQcow2ToNbdWaitPeriod" : 12345
  },
  "hvHypervSettings" : {
    "hypervExportChunksNumber" : 12345
  },
  "trustAllCerts" : true
}
                
              
Response
HTTP/1.1 201 Created
Content-Type: application/json

                
{
  "host" : "...",
  "sshPort" : 12345,
  "nodeConfig" : {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  },
  "user" : "...",
  "sshKeyPath" : "...",
  "vmCount" : 12345,
  "hvManager" : {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  },
  "hvmType" : {
    "name" : "ENUM_NAME",
    "description" : "Enum description"
  },
  "vmExportImportMode" : "INHERIT",
  "transferNicAddress" : "...",
  "dataCenterName" : "...",
  "cluster" : {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  },
  "vmOwner" : "...",
  "vmOwningGroup" : "...",
  "storageType" : "DEFAULT",
  "storageProvider" : {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  },
  "licenseCovered" : true,
  "useNetcat" : true,
  "citrixSettings" : {
    "citrixExportRefreshRate" : 12345,
    "citrixEnableXvaCompression" : true,
    "citrixSnapshotRemovalTimeout" : 12345
  },
  "libvirtSettings" : {
    "libvirtSshTimeout" : 12345,
    "libvirtSshKnownHostsPath" : "...",
    "libvirtSshProgressRefreshRate" : 12345,
    "libvirtLvmSnapshotSize" : "...",
    "libvirtLvmSnapshotExtents" : "...",
    "libvirtAlwaysExportFullIfVmTurnedOff" : true
  },
  "proxmoxSettings" : {
    "proxmoxBackupStorage" : "...",
    "proxmoxCompressionType" : "GZIP",
    "proxmoxNbdBufferReleaseMaxAttempts" : 12345,
    "proxmoxNbdBufferReleaseTimeout" : 12345,
    "proxmoxNbdBufferReleaseWaitPeriod" : 12345,
    "proxmoxAvailableNbdWaitPeriod" : 12345,
    "proxmoxConnectQcow2ToNbdWaitPeriod" : 12345
  },
  "hvHypervSettings" : {
    "hypervExportChunksNumber" : 12345,
    "hypevisorManagerHypervType" : "..."
  },
  "lastInventorySyncDate" : 12345,
  "lastSuccessfulInventorySyncDate" : 12345,
  "possibleActions" : [ "WRITE", "HVM_READ" ],
  "version" : "...",
  "trustAllCerts" : true,
  "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
  "type" : {
    "name" : "ENUM_NAME",
    "description" : "Enum description"
  }
}
                
              

PUT /hypervisors

Change node for specified list of hypervisors.

Request Body
media type data type description
application/json HypervisorBatchUpdate (JSON) specify node and guids of hypervisors
Response Body
media type data type description
application/json BatchResponse (JSON) list of successful and unsuccessful updates of node

Example

Request
PUT /hypervisors
Content-Type: application/json
Accept: application/json

                
{
  "hypervisors" : [ {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  }, {
    "guid" : "...",
    "name" : "..."
  } ],
  "nodeConfig" : {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  }
}
                
              
Response
HTTP/1.1 204 No Content
Content-Type: application/json

                
{
  "successful" : [ {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  }, {
    "guid" : "...",
    "name" : "..."
  } ],
  "unsuccessful" : [ {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  }, {
    "guid" : "...",
    "name" : "..."
  } ]
}
                
              

GET /hypervisors/detailed

Returns detailed list of hypervisors filtered by specified query parameters.

Request Parameters
name type description constraints
backup-to-be-restored query  
direction query  
filter query  
hypervisor-manager query  
nameLike query  
orderBy query  
page query  
size query  
snapshotable query boolean
type query "CITRIX" or "ESXI" or "HYPERV" or "KUBERNETES" or "KVM" or "NUTANIX" or "OPENSHIFT" or "OVM" or "PROXMOX" or "XEN"
Response Body
media type data type description
application/json array of HypervisorDetails (JSON) detailed list of hypervisors filtered by specified query parameters

Example

Request
GET /hypervisors/detailed
Content-Type: */*
Accept: application/json

                
...
                
              
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
[ {
  "host" : "...",
  "sshPort" : 12345,
  "nodeConfig" : {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  },
  "user" : "...",
  "sshKeyPath" : "...",
  "vmCount" : 12345,
  "hvManager" : {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  },
  "hvmType" : {
    "name" : "ENUM_NAME",
    "description" : "Enum description"
  },
  "vmExportImportMode" : "CHANGED_BLOCK_TRACKING",
  "transferNicAddress" : "...",
  "dataCenterName" : "...",
  "cluster" : {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  },
  "vmOwner" : "...",
  "vmOwningGroup" : "...",
  "storageType" : "DEFAULT",
  "storageProvider" : {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  },
  "licenseCovered" : true,
  "useNetcat" : true,
  "citrixSettings" : {
    "citrixExportRefreshRate" : 12345,
    "citrixEnableXvaCompression" : true,
    "citrixSnapshotRemovalTimeout" : 12345
  },
  "libvirtSettings" : {
    "libvirtSshTimeout" : 12345,
    "libvirtSshKnownHostsPath" : "...",
    "libvirtSshProgressRefreshRate" : 12345,
    "libvirtLvmSnapshotSize" : "...",
    "libvirtLvmSnapshotExtents" : "...",
    "libvirtAlwaysExportFullIfVmTurnedOff" : true
  },
  "proxmoxSettings" : {
    "proxmoxBackupStorage" : "...",
    "proxmoxCompressionType" : "LZO",
    "proxmoxNbdBufferReleaseMaxAttempts" : 12345,
    "proxmoxNbdBufferReleaseTimeout" : 12345,
    "proxmoxNbdBufferReleaseWaitPeriod" : 12345,
    "proxmoxAvailableNbdWaitPeriod" : 12345,
    "proxmoxConnectQcow2ToNbdWaitPeriod" : 12345
  },
  "hvHypervSettings" : {
    "hypervExportChunksNumber" : 12345,
    "hypevisorManagerHypervType" : "..."
  },
  "lastInventorySyncDate" : 12345,
  "lastSuccessfulInventorySyncDate" : 12345,
  "possibleActions" : [ "INVENTORY_SYNC", "INVENTORY_SYNC" ],
  "version" : "...",
  "trustAllCerts" : true,
  "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
  "type" : {
    "name" : "ENUM_NAME",
    "description" : "Enum description"
  }
} ]
                
              

GET /hypervisors/for-restore

Returns list of hypervisors filtered by specified query parameters for restore operation

Request Parameters
name type description constraints
backup-to-be-restored query  
direction query  
filter query  
hypervisor-manager query  
nameLike query  
orderBy query  
page query  
size query  
snapshotable query boolean
type query "CITRIX" or "ESXI" or "HYPERV" or "KUBERNETES" or "KVM" or "NUTANIX" or "OPENSHIFT" or "OVM" or "PROXMOX" or "XEN"
Response Body
media type data type description
application/json array of HypervisorForRestoreListRecord (JSON) list of hypervisor infos for restore filtered by specified query parameters

Example

Request
GET /hypervisors/for-restore
Content-Type: */*
Accept: application/json

                
...
                
              
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
[ {
  "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
  "host" : "https://some.host:8181/api",
  "type" : {
    "name" : "ENUM_NAME",
    "description" : "Enum description"
  }
} ]
                
              

PUT /hypervisors/licensed

Change license coverage for specified list of hypervisors.

Request Body
media type data type description
application/json SingleAttributeBatchUpdate (JSON) specify license coverage and guids of hypervisors
Response Body
media type data type description
application/json BatchResponse (JSON) list of successful and unsuccessful updates of license coverage

Example

Request
PUT /hypervisors/licensed
Content-Type: application/json
Accept: application/json

                
{
  "value" : "...",
  "entities" : [ {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  }, {
    "guid" : "...",
    "name" : "..."
  } ]
}
                
              
Response
HTTP/1.1 204 No Content
Content-Type: application/json

                
{
  "successful" : [ {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  }, {
    "guid" : "...",
    "name" : "..."
  } ],
  "unsuccessful" : [ {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  }, {
    "guid" : "...",
    "name" : "..."
  } ]
}
                
              

PUT /hypervisors/password

Change password for specified list of hypervisors.

Request Body
media type data type description
application/json SingleAttributeBatchUpdate (JSON) specify new password and guids of hypervisors
Response Body
media type data type description
application/json BatchResponse (JSON) list of successful and unsuccessful updates of password

Example

Request
PUT /hypervisors/password
Content-Type: application/json
Accept: application/json

                
{
  "value" : "...",
  "entities" : [ {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  }, {
    "guid" : "...",
    "name" : "..."
  } ]
}
                
              
Response
HTTP/1.1 204 No Content
Content-Type: application/json

                
{
  "successful" : [ {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  }, {
    "guid" : "...",
    "name" : "..."
  } ],
  "unsuccessful" : [ {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  }, {
    "guid" : "...",
    "name" : "..."
  } ]
}
                
              

GET /hypervisors/rbac-contexts

Returns list of hypervisors filtered by specified query parameters.

Request Parameters
name type description constraints
app-cmd-exec-config query  
cloud-service-provider query  
cluster query  
data-center query  
direction query  
filter query  
hypervisor query  
hypervisor-manager query  
nameLike query  
orderBy query  
page query  
project query  
size query  
storage-pool query  
storage-provider query  
teams-group query boolean
Response Body
media type data type description
application/json array of RbacContextListRecord (JSON) list of hypervisors filtered by specified query parameters

Example

Request
GET /hypervisors/rbac-contexts
Content-Type: */*
Accept: application/json

                
...
                
              
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
[ {
  "nameAndGuid" : {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  },
  "uuid" : "...",
  "type" : "DATA_CENTER",
  "checked" : true,
  "lastLevel" : true,
  "present" : true,
  "entityType" : "...",
  "childrenQueryType" : "..."
} ]
                
              

PUT /hypervisors/ssh-key-path

Change ssh key path for specified list of hypervisors.

Request Body
media type data type description
application/json SingleAttributeBatchUpdate (JSON) specify new ssh key path and guids of hypervisors
Response Body
media type data type description
application/json BatchResponse (JSON) list of successful and unsuccessful updates of ssh key path

Example

Request
PUT /hypervisors/ssh-key-path
Content-Type: application/json
Accept: application/json

                
{
  "value" : "...",
  "entities" : [ {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  }, {
    "guid" : "...",
    "name" : "..."
  } ]
}
                
              
Response
HTTP/1.1 204 No Content
Content-Type: application/json

                
{
  "successful" : [ {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  }, {
    "guid" : "...",
    "name" : "..."
  } ],
  "unsuccessful" : [ {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  }, {
    "guid" : "...",
    "name" : "..."
  } ]
}
                
              

PUT /hypervisors/user

Change user for specified list of hypervisors.

Request Body
media type data type description
application/json SingleAttributeBatchUpdate (JSON) specify new user and guids of hypervisors
Response Body
media type data type description
application/json BatchResponse (JSON) list of successful and unsuccessful updates of user

Example

Request
PUT /hypervisors/user
Content-Type: application/json
Accept: application/json

                
{
  "value" : "...",
  "entities" : [ {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  }, {
    "guid" : "...",
    "name" : "..."
  } ]
}
                
              
Response
HTTP/1.1 204 No Content
Content-Type: application/json

                
{
  "successful" : [ {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  }, {
    "guid" : "...",
    "name" : "..."
  } ],
  "unsuccessful" : [ {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  }, {
    "guid" : "...",
    "name" : "..."
  } ]
}
                
              

DELETE /hypervisors/{guid}

Remove hypervisor.

Request Parameters
name type description
guid path specify local unique identifier for hypervisor (use by vProtect)

Example

Request
DELETE /hypervisors/{guid}
Content-Type: */*

                
...
                
              
Response
HTTP/1.1 204 No Content

              

GET /hypervisors/{guid}

Get a single hypervisor.

Request Parameters
name type description
guid path specify local unique identifier for hypervisor (use by vProtect)
Response Body
media type data type description
application/json HypervisorDetails (JSON) hypervisor details

Example

Request
GET /hypervisors/{guid}
Content-Type: */*
Accept: application/json

                
...
                
              
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "host" : "...",
  "sshPort" : 12345,
  "nodeConfig" : {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  },
  "user" : "...",
  "sshKeyPath" : "...",
  "vmCount" : 12345,
  "hvManager" : {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  },
  "hvmType" : {
    "name" : "ENUM_NAME",
    "description" : "Enum description"
  },
  "vmExportImportMode" : "EXPORT_STORAGE_REPO",
  "transferNicAddress" : "...",
  "dataCenterName" : "...",
  "cluster" : {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  },
  "vmOwner" : "...",
  "vmOwningGroup" : "...",
  "storageType" : "CEPH",
  "storageProvider" : {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  },
  "licenseCovered" : true,
  "useNetcat" : true,
  "citrixSettings" : {
    "citrixExportRefreshRate" : 12345,
    "citrixEnableXvaCompression" : true,
    "citrixSnapshotRemovalTimeout" : 12345
  },
  "libvirtSettings" : {
    "libvirtSshTimeout" : 12345,
    "libvirtSshKnownHostsPath" : "...",
    "libvirtSshProgressRefreshRate" : 12345,
    "libvirtLvmSnapshotSize" : "...",
    "libvirtLvmSnapshotExtents" : "...",
    "libvirtAlwaysExportFullIfVmTurnedOff" : true
  },
  "proxmoxSettings" : {
    "proxmoxBackupStorage" : "...",
    "proxmoxCompressionType" : "GZIP",
    "proxmoxNbdBufferReleaseMaxAttempts" : 12345,
    "proxmoxNbdBufferReleaseTimeout" : 12345,
    "proxmoxNbdBufferReleaseWaitPeriod" : 12345,
    "proxmoxAvailableNbdWaitPeriod" : 12345,
    "proxmoxConnectQcow2ToNbdWaitPeriod" : 12345
  },
  "hvHypervSettings" : {
    "hypervExportChunksNumber" : 12345,
    "hypevisorManagerHypervType" : "..."
  },
  "lastInventorySyncDate" : 12345,
  "lastSuccessfulInventorySyncDate" : 12345,
  "possibleActions" : [ "INVENTORY_SYNC", "HV_READ" ],
  "version" : "...",
  "trustAllCerts" : true,
  "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
  "type" : {
    "name" : "ENUM_NAME",
    "description" : "Enum description"
  }
}
                
              

PUT /hypervisors/{guid}

Change hypervisor details.

Request Parameters
name type description
guid path specify local unique identifier for hypervisor (use by vProtect)
Request Body
media type data type description
application/json HypervisorUpdate (JSON) specify hypervisor details to update
Response Body
media type data type description
application/json HypervisorDetails (JSON) updated details of hypervisor

Example

Request
PUT /hypervisors/{guid}
Content-Type: application/json
Accept: application/json

                
{
  "host" : "...",
  "sshPort" : 12345,
  "nodeConfig" : {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  },
  "sshKeyPath" : "...",
  "user" : "...",
  "vmExportImportMode" : "DISK_ATTACHMENT_CHANGED_BLOCK_TRACKING",
  "transferNicAddress" : "...",
  "dataCenterName" : "...",
  "cluster" : {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  },
  "vmOwner" : "...",
  "vmOwningGroup" : "...",
  "storageProvider" : {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  },
  "storageType" : "CEPH",
  "licenseCovered" : true,
  "useNetcat" : true,
  "libvirtSettings" : {
    "libvirtSshTimeout" : 12345,
    "libvirtSshKnownHostsPath" : "...",
    "libvirtSshProgressRefreshRate" : 12345,
    "libvirtLvmSnapshotSize" : "...",
    "libvirtLvmSnapshotExtents" : "...",
    "libvirtAlwaysExportFullIfVmTurnedOff" : true
  },
  "citrixSettings" : {
    "citrixExportRefreshRate" : 12345,
    "citrixEnableXvaCompression" : true,
    "citrixSnapshotRemovalTimeout" : 12345
  },
  "proxmoxSettings" : {
    "proxmoxBackupStorage" : "...",
    "proxmoxCompressionType" : "GZIP",
    "proxmoxNbdBufferReleaseMaxAttempts" : 12345,
    "proxmoxNbdBufferReleaseTimeout" : 12345,
    "proxmoxNbdBufferReleaseWaitPeriod" : 12345,
    "proxmoxAvailableNbdWaitPeriod" : 12345,
    "proxmoxConnectQcow2ToNbdWaitPeriod" : 12345
  },
  "hvHypervSettings" : {
    "hypervExportChunksNumber" : 12345
  },
  "trustAllCerts" : true
}
                
              
Response
HTTP/1.1 204 No Content
Content-Type: application/json

                
{
  "host" : "...",
  "sshPort" : 12345,
  "nodeConfig" : {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  },
  "user" : "...",
  "sshKeyPath" : "...",
  "vmCount" : 12345,
  "hvManager" : {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  },
  "hvmType" : {
    "name" : "ENUM_NAME",
    "description" : "Enum description"
  },
  "vmExportImportMode" : "DISK_IMAGE_TRANSFER",
  "transferNicAddress" : "...",
  "dataCenterName" : "...",
  "cluster" : {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  },
  "vmOwner" : "...",
  "vmOwningGroup" : "...",
  "storageType" : "DEFAULT",
  "storageProvider" : {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  },
  "licenseCovered" : true,
  "useNetcat" : true,
  "citrixSettings" : {
    "citrixExportRefreshRate" : 12345,
    "citrixEnableXvaCompression" : true,
    "citrixSnapshotRemovalTimeout" : 12345
  },
  "libvirtSettings" : {
    "libvirtSshTimeout" : 12345,
    "libvirtSshKnownHostsPath" : "...",
    "libvirtSshProgressRefreshRate" : 12345,
    "libvirtLvmSnapshotSize" : "...",
    "libvirtLvmSnapshotExtents" : "...",
    "libvirtAlwaysExportFullIfVmTurnedOff" : true
  },
  "proxmoxSettings" : {
    "proxmoxBackupStorage" : "...",
    "proxmoxCompressionType" : "DISABLED",
    "proxmoxNbdBufferReleaseMaxAttempts" : 12345,
    "proxmoxNbdBufferReleaseTimeout" : 12345,
    "proxmoxNbdBufferReleaseWaitPeriod" : 12345,
    "proxmoxAvailableNbdWaitPeriod" : 12345,
    "proxmoxConnectQcow2ToNbdWaitPeriod" : 12345
  },
  "hvHypervSettings" : {
    "hypervExportChunksNumber" : 12345,
    "hypevisorManagerHypervType" : "..."
  },
  "lastInventorySyncDate" : 12345,
  "lastSuccessfulInventorySyncDate" : 12345,
  "possibleActions" : [ "READ", "WRITE" ],
  "version" : "...",
  "trustAllCerts" : true,
  "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
  "type" : {
    "name" : "ENUM_NAME",
    "description" : "Enum description"
  }
}
                
              

PUT /hypervisors/{guid}/certificates

Change hypervisor certificate settings.

Request Parameters
name type description
guid path specify local unique identifier for hypervisor (use by vProtect)
Request Body
media type data type description
application/json HypervisorCertificateSettingsUpdate (JSON) specify hypervisor certificate settings to update
Response Body
media type data type description
application/json HypervisorDetails (JSON) updated details of hypervisor

Example

Request
PUT /hypervisors/{guid}/certificates
Content-Type: application/json
Accept: application/json

                
{
  "trustAllCerts" : true
}
                
              
Response
HTTP/1.1 204 No Content
Content-Type: application/json

                
{
  "host" : "...",
  "sshPort" : 12345,
  "nodeConfig" : {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  },
  "user" : "...",
  "sshKeyPath" : "...",
  "vmCount" : 12345,
  "hvManager" : {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  },
  "hvmType" : {
    "name" : "ENUM_NAME",
    "description" : "Enum description"
  },
  "vmExportImportMode" : "DISK_IMAGE_TRANSFER",
  "transferNicAddress" : "...",
  "dataCenterName" : "...",
  "cluster" : {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  },
  "vmOwner" : "...",
  "vmOwningGroup" : "...",
  "storageType" : "CEPH",
  "storageProvider" : {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  },
  "licenseCovered" : true,
  "useNetcat" : true,
  "citrixSettings" : {
    "citrixExportRefreshRate" : 12345,
    "citrixEnableXvaCompression" : true,
    "citrixSnapshotRemovalTimeout" : 12345
  },
  "libvirtSettings" : {
    "libvirtSshTimeout" : 12345,
    "libvirtSshKnownHostsPath" : "...",
    "libvirtSshProgressRefreshRate" : 12345,
    "libvirtLvmSnapshotSize" : "...",
    "libvirtLvmSnapshotExtents" : "...",
    "libvirtAlwaysExportFullIfVmTurnedOff" : true
  },
  "proxmoxSettings" : {
    "proxmoxBackupStorage" : "...",
    "proxmoxCompressionType" : "LZO",
    "proxmoxNbdBufferReleaseMaxAttempts" : 12345,
    "proxmoxNbdBufferReleaseTimeout" : 12345,
    "proxmoxNbdBufferReleaseWaitPeriod" : 12345,
    "proxmoxAvailableNbdWaitPeriod" : 12345,
    "proxmoxConnectQcow2ToNbdWaitPeriod" : 12345
  },
  "hvHypervSettings" : {
    "hypervExportChunksNumber" : 12345,
    "hypevisorManagerHypervType" : "..."
  },
  "lastInventorySyncDate" : 12345,
  "lastSuccessfulInventorySyncDate" : 12345,
  "possibleActions" : [ "HVM_READ", "HV_READ" ],
  "version" : "...",
  "trustAllCerts" : true,
  "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
  "type" : {
    "name" : "ENUM_NAME",
    "description" : "Enum description"
  }
}
                
              

PUT /hypervisors/{guid}/password

Change password for specified hypervisor.

Request Parameters
name type description
guid path specify local unique identifier for hypervisor (use by vProtect)
Request Body
media type data type description
application/json StringDTO (JSON) specify new password to update

Example

Request
PUT /hypervisors/{guid}/password
Content-Type: application/json

                
{
  "value" : "..."
}
                
              
Response
HTTP/1.1 204 No Content

              

GET /hypervisors/{guid}/statistics

Returns architecture statistics from hypervisor.

Request Parameters
name type description constraints
guid path specify local unique identifier for hypervisor (use by vProtect)  
compute-zone query  
from query long
to query long
Response Body
media type data type description
application/json VirtualProviderStatisticsDetails (JSON) architecture statistics from hypervisor

Example

Request
GET /hypervisors/{guid}/statistics
Content-Type: */*
Accept: application/json

                
...
                
              
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "hypervisorCount" : 12345,
  "hypervisorClusterCount" : 12345,
  "hypervisorStorageCount" : 12345,
  "virtualMachineCount" : 12345,
  "networkCount" : 12345,
  "projectCount" : 12345,
  "accessKeyCount" : 12345,
  "vmFlavorCount" : 12345,
  "backupCount" : 12345,
  "backupHistoryCount" : 12345,
  "restoreJobCount" : 12345,
  "quotaCount" : 12345,
  "certificatesCount" : 12345,
  "authDomainCount" : 12345
}