Virtual Machines Controller Resource

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

GET /virtual-machines

Returns list of virtual machines filtered by specified query parameters.

Request Parameters
name type description constraints multivalued
authentication-domain query   no
backupStatus query "IS_PROTECTED" or "NOT_PROTECTED" or "NO_SCHEDULE" yes
data-center query   no
detailed query required no
direction query   no
filter query   no
guids query   yes
hypervisor query   no
hypervisor-cluster query   no
hypervisor-manager query   no
hypervisor-manager-type query "AWS" or "AZURE" or "FUSIONCOMPUTE" or "GCP" or "HC3" or "HYPERV" or "KUBERNETES" or "NUTANIX" or "OPENNEBULA" or "OPENSHIFT" or "OPENSTACK" or "ORACLE" or "RHEV" or "RHV" or "VCENTER" or "VIRTUOZZO" yes
hypervisor-type query "CITRIX" or "ESXI" or "HYPERV" or "KUBERNETES" or "KVM" or "NUTANIX" or "OPENSHIFT" or "OVM" or "PROXMOX" or "XEN" yes
nameLike query   no
nodeConfig query   no
orderBy query   no
page query   no
present query boolean no
project-uuid query   no
size query   no
snapshotPolicy query   no
snapshotable query boolean no
uuid query   no
uuids query   yes
vmPolicy query   yes
Response Body
media type data type description
application/json array of VirtualMachineListRecord (JSON) list of virtual machines filtered by specified query parameters

Example

Request
GET /virtual-machines
Content-Type: */*
Accept: application/json

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

                
[ {
  "name" : "...",
  "type" : "APP",
  "backupUpToDate" : true,
  "restorable" : true,
  "uuid" : "...",
  "hypervisor" : {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  },
  "lastSuccessfulBackupSize" : 12345,
  "hvManager" : {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  },
  "lastSuccessfulFullBackupSize" : 12345,
  "dataCenter" : {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  },
  "warningsPresent" : true,
  "hvCluster" : {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  },
  "lastSuccessfulFullBackup" : {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  },
  "vmBackupPolicy" : {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  },
  "present" : true,
  "lastSuccessfulIncBackup" : {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  },
  "hvType" : "KVM",
  "averageProgress" : 12345.0,
  "lastChainMarkedForDeletion" : true,
  "hvmType" : "OPENSTACK",
  "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
  "project" : {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  },
  "lastBackup" : 1451649601000,
  "originalName" : "...",
  "restoreStatus" : "...",
  "possibleActions" : [ "WRITE", "INVENTORY_SYNC" ],
  "rule" : {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  },
  "vmFlavor" : {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  },
  "accessKey" : {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  },
  "networks" : [ {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  }, {
    "guid" : "...",
    "name" : "..."
  } ],
  "supportsQuiesceSnapshot" : true
} ]
                
              

DELETE /virtual-machines/all-non-present

Remove all virtual machines that are not present and without any backup.

Request Parameters
name type description
project-uuid query specify project UUID to delete not present vms in project

Example

Request
DELETE /virtual-machines/all-non-present
Content-Type: */*

                
...
                
              
Response
HTTP/1.1 204 No Content

              

POST /virtual-machines/assign-backup-policy

Assign virtual machines to specified policy (or unassign if policy is null)

Request Body
media type data type description
application/json ProtectedEntityBackupPolicyAssignmentRequest (JSON) containing policy and vms info
Response Body
media type data type description
application/json array of VirtualMachineDetails (JSON) list of updated virtual machines

Example

Request
POST /virtual-machines/assign-backup-policy
Content-Type: application/json
Accept: application/json

                
{
  "backupPolicy" : "...",
  "protectedEntities" : [ {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  }, {
    "guid" : "...",
    "name" : "..."
  } ]
}
                
              
Response
HTTP/1.1 201 Created
Content-Type: application/json

                
[ {
  "sshHost" : "...",
  "sshPort" : 12345,
  "credential" : {
    "guid" : "...",
    "name" : "...",
    "user" : "...",
    "secretKey" : "...",
    "sshKey" : "...",
    "sshKeyPath" : "...",
    "powerShellTransportType" : "NTLM"
  },
  "sshKeyPath" : "...",
  "backupCount" : 12345,
  "rules" : [ {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  }, {
    "guid" : "...",
    "name" : "..."
  } ],
  "name" : "...",
  "type" : "CLOUD_TEAMS",
  "backupUpToDate" : true,
  "restorable" : true,
  "lastSuccessfulBackupSize" : 12345,
  "lastSuccessfulFullBackupSize" : 12345,
  "warningsPresent" : true,
  "lastSuccessfulFullBackup" : {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  },
  "lastSuccessfulIncBackup" : {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  },
  "averageProgress" : 12345.0,
  "lastChainMarkedForDeletion" : true,
  "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
  "lastBackup" : 1451649601000,
  "uuid" : "...",
  "hypervisor" : {
    "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" : "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" : [ "HV_READ", "HV_READ" ],
    "version" : "...",
    "trustAllCerts" : true,
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "type" : {
      "name" : "ENUM_NAME",
      "description" : "Enum description"
    }
  },
  "hvManager" : {
    "url" : "...",
    "sshPort" : 12345,
    "nodeConfig" : {
      "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
      "name" : "Entity name"
    },
    "user" : "...",
    "sshKeyPath" : "...",
    "hvCount" : 12345,
    "vmCount" : 12345,
    "vmExportImportMode" : "DISK_IMAGE_TRANSFER",
    "baseImageCreationConfig" : {
      "windowsImageRequired" : "INHERIT",
      "linuxImageRequired" : "INHERIT"
    },
    "account" : "...",
    "useNetcat" : true,
    "storageType" : "CEPH",
    "region" : "...",
    "endpointInterfaceType" : "INTERNAL",
    "ovmSettings" : {
      "ovmJobStatusPollingInterval" : 12345,
      "ovmPoolToRepoMappings" : [ { }, { } ],
      "ovmExportCloneTypeOverride" : "THIN_CLONE"
    },
    "rhvSettings" : {
      "rhvSnapshotCloneTimeout" : 12345,
      "rhvSnapshotCreationTimeout" : 12345,
      "rhvVmExportTimeout" : 12345,
      "rhvDiskUnlockTimeout" : 12345,
      "rhvMultiDatacenterExport" : true,
      "rhvSnapshotRemovalTimeout" : 12345,
      "rhvDcToSdMappings" : [ { }, { } ]
    },
    "awsSettings" : {
      "awsSnapshotCreationTimeout" : 12345,
      "awsImageCreationTimeout" : 12345,
      "awsVolumeActionsTimeout" : 12345,
      "awsInstanceCreationTimeout" : 12345
    },
    "vmwareSettings" : {
      "vmwareTagCategory" : "..."
    },
    "openStackSettings" : {
      "openstackDownloadImageFromGlance" : true,
      "openstackScopeVmsToDomain" : true
    },
    "nutanixSettings" : {
      "nutanixSnapshotRemovalTimeout" : 12345,
      "maxNutanixSnapshotCreatingTimeout" : 12345,
      "nutanixDiskOperationTimeout" : 12345
    },
    "oadpSettings" : {
      "oadpProjectName" : "...",
      "oadpStorageClassName" : "..."
    },
    "hvmHypervSettings" : {
      "hypervExportChunksNumber" : 12345,
      "hypevisorManagerHypervType" : "..."
    },
    "hvmAzureSettings" : {
      "azureClientId" : "...",
      "azureClientSecret" : "...",
      "azureSubscriptionId" : "...",
      "azureTenantId" : "..."
    },
    "gcpSettings" : {
      "gcpOrganizationId" : "..."
    },
    "useToken" : true,
    "lastInventorySyncDate" : 12345,
    "lastSuccessfulInventorySyncDate" : 12345,
    "possibleActions" : [ "INVENTORY_SYNC", "READ" ],
    "version" : "...",
    "trustAllCerts" : true,
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "type" : {
      "name" : "ENUM_NAME",
      "description" : "Enum description"
    }
  },
  "resourceGroup" : {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  },
  "vmBackupPolicy" : {
    "rules" : [ {
      "guid" : "...",
      "name" : "...",
      "policy" : { },
      "schedules" : [ { }, { } ],
      "vmCount" : 12345,
      "schedulesCount" : 12345,
      "position" : 12345,
      "active" : true,
      "removable" : true,
      "daysToKeepRetentionLock" : 12345
    }, {
      "guid" : "...",
      "name" : "...",
      "policy" : { },
      "schedules" : [ { }, { } ],
      "vmCount" : 12345,
      "schedulesCount" : 12345,
      "position" : 12345,
      "active" : true,
      "removable" : true,
      "daysToKeepRetentionLock" : 12345
    } ],
    "name" : "...",
    "active" : true,
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "priority" : 50,
    "autoAssignSettings" : {
      "mode" : "ASSIGN_ONLY",
      "includeRegExps" : [ "...", "..." ],
      "excludeRegExps" : [ "...", "..." ],
      "includeTags" : [ "...", "..." ],
      "excludeTags" : [ "...", "..." ],
      "hvClusters" : [ { }, { } ],
      "projects" : [ { }, { } ]
    },
    "autoRemoveNonPresent" : true,
    "vms" : [ {
      "name" : "...",
      "type" : "STORAGE",
      "backupUpToDate" : true,
      "restorable" : true,
      "uuid" : "...",
      "hypervisor" : { },
      "lastSuccessfulBackupSize" : 12345,
      "hvManager" : { },
      "lastSuccessfulFullBackupSize" : 12345,
      "dataCenter" : { },
      "warningsPresent" : true,
      "hvCluster" : { },
      "lastSuccessfulFullBackup" : { },
      "vmBackupPolicy" : { },
      "present" : true,
      "lastSuccessfulIncBackup" : { },
      "hvType" : "KVM",
      "averageProgress" : 12345.0,
      "lastChainMarkedForDeletion" : true,
      "hvmType" : "OPENSTACK",
      "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
      "project" : { },
      "lastBackup" : 1451649601000,
      "originalName" : "...",
      "restoreStatus" : "...",
      "possibleActions" : [ "READ", "HV_READ" ],
      "rule" : { },
      "vmFlavor" : { },
      "accessKey" : { },
      "networks" : [ { }, { } ],
      "supportsQuiesceSnapshot" : true
    }, {
      "name" : "...",
      "type" : "CLOUD",
      "backupUpToDate" : true,
      "restorable" : true,
      "uuid" : "...",
      "hypervisor" : { },
      "lastSuccessfulBackupSize" : 12345,
      "hvManager" : { },
      "lastSuccessfulFullBackupSize" : 12345,
      "dataCenter" : { },
      "warningsPresent" : true,
      "hvCluster" : { },
      "lastSuccessfulFullBackup" : { },
      "vmBackupPolicy" : { },
      "present" : true,
      "lastSuccessfulIncBackup" : { },
      "hvType" : "HYPERV",
      "averageProgress" : 12345.0,
      "lastChainMarkedForDeletion" : true,
      "hvmType" : "OPENSHIFT",
      "guid" : "...",
      "project" : { },
      "lastBackup" : 12345,
      "originalName" : "...",
      "restoreStatus" : "...",
      "possibleActions" : [ "HV_READ", "INVENTORY_SYNC" ],
      "rule" : { },
      "vmFlavor" : { },
      "accessKey" : { },
      "networks" : [ { }, { } ],
      "supportsQuiesceSnapshot" : true
    } ],
    "averageBackupSize" : 12345,
    "failRemainingBackupTasksExportThreshold" : 12345.0,
    "failRemainingBackupTasksStoreThreshold" : 12345.0,
    "projects" : [ {
      "guid" : "...",
      "name" : "...",
      "hvManager" : { },
      "uuid" : "..."
    }, {
      "guid" : "...",
      "name" : "...",
      "hvManager" : { },
      "uuid" : "..."
    } ],
    "visibleForAllProjects" : true,
    "backupRetryCount" : 12345,
    "dailyReportEnabled" : true,
    "mailingList" : {
      "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
      "name" : "Entity name"
    },
    "disableCleanOldBackups" : true,
    "quiesceBeforeSnapshot" : true
  },
  "snapshotMgmtPolicy" : {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  },
  "present" : true,
  "dataCenter" : {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  },
  "hvCluster" : {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  },
  "tags" : [ "...", "..." ],
  "hvType" : "KVM",
  "hvmType" : "OPENSTACK",
  "vmExportImportMode" : "INHERIT",
  "preCommand" : {
    "commandArgs" : [ "...", "..." ],
    "commandType" : "POWERSHELL",
    "executionStage" : "PRE"
  },
  "postCommand" : {
    "commandArgs" : [ "...", "..." ],
    "commandType" : "POWERSHELL",
    "executionStage" : "POST"
  },
  "preSnapCmdExecEnabled" : true,
  "postSnapCmdExecEnabled" : true,
  "preSnapIgnoredExitCodes" : "...",
  "postSnapIgnoredExitCodes" : "...",
  "preSnapStdErrorHandling" : "IGNORE_WITHOUT_WARNING",
  "postSnapStdErrorHandling" : "IGNORE_WITH_WARNING",
  "preSnapCmdExecTimeout" : 12345,
  "postSnapCmdExecTimeout" : 12345,
  "baseImageCreationConfig" : {
    "windowsImageRequired" : "FALSE",
    "linuxImageRequired" : "TRUE"
  },
  "project" : {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  },
  "externalReference" : "...",
  "originalName" : "...",
  "possibleActions" : [ "INVENTORY_SYNC", "HVM_READ" ],
  "networkInterfaceCards" : [ {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  }, {
    "guid" : "...",
    "name" : "..."
  } ],
  "lastStoredSnapshotAssignments" : [ {
    "protectedEntitySnapshot" : {
      "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
      "name" : "Entity name"
    },
    "virtualMachine" : {
      "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
      "name" : "Entity name"
    },
    "backupRule" : {
      "guid" : "...",
      "name" : "...",
      "policy" : { },
      "schedules" : [ { }, { } ],
      "ruleBackupDestinations" : [ { }, { } ],
      "vmCount" : 12345,
      "schedulesCount" : 12345,
      "position" : 12345,
      "active" : true,
      "backupCount" : 12345,
      "removable" : true,
      "markedForDeletion" : true,
      "daysToKeepRetentionLock" : 12345
    }
  }, {
    "protectedEntitySnapshot" : {
      "guid" : "...",
      "name" : "..."
    },
    "virtualMachine" : {
      "guid" : "...",
      "name" : "..."
    },
    "backupRule" : {
      "guid" : "...",
      "name" : "...",
      "policy" : { },
      "schedules" : [ { }, { } ],
      "ruleBackupDestinations" : [ { }, { } ],
      "vmCount" : 12345,
      "schedulesCount" : 12345,
      "position" : 12345,
      "active" : true,
      "backupCount" : 12345,
      "removable" : true,
      "markedForDeletion" : true,
      "daysToKeepRetentionLock" : 12345
    }
  } ],
  "vmResourceType" : "DEPLOYMENT_CONFIG",
  "vmFlavor" : {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  },
  "accessKey" : {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  }
} ]
                
              

GET /virtual-machines/backup-cleanup

Returns list of protected entities for backup cleanup.

Request Parameters
name type description
backup-destination query
Response Body
media type data type description
application/json array of VirtualMachineListRecord (JSON) list of protected entities for backup cleanup

Example

Request
GET /virtual-machines/backup-cleanup
Content-Type: */*
Accept: application/json

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

                
[ {
  "name" : "...",
  "type" : "CLOUD",
  "backupUpToDate" : true,
  "restorable" : true,
  "uuid" : "...",
  "hypervisor" : {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  },
  "lastSuccessfulBackupSize" : 12345,
  "hvManager" : {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  },
  "lastSuccessfulFullBackupSize" : 12345,
  "dataCenter" : {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  },
  "warningsPresent" : true,
  "hvCluster" : {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  },
  "lastSuccessfulFullBackup" : {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  },
  "vmBackupPolicy" : {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  },
  "present" : true,
  "lastSuccessfulIncBackup" : {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  },
  "hvType" : "KVM",
  "averageProgress" : 12345.0,
  "lastChainMarkedForDeletion" : true,
  "hvmType" : "OPENSTACK",
  "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
  "project" : {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  },
  "lastBackup" : 1451649601000,
  "originalName" : "...",
  "restoreStatus" : "...",
  "possibleActions" : [ "INVENTORY_SYNC", "INVENTORY_SYNC" ],
  "rule" : {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  },
  "vmFlavor" : {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  },
  "accessKey" : {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  },
  "networks" : [ {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  }, {
    "guid" : "...",
    "name" : "..."
  } ],
  "supportsQuiesceSnapshot" : true
} ]
                
              

GET /virtual-machines/detailed

Returns detailed list of virtual machines filtered by specified query parameters.

Request Parameters
name type description constraints multivalued
authentication-domain query   no
backupStatus query "IS_PROTECTED" or "NOT_PROTECTED" or "NO_SCHEDULE" yes
data-center query   no
detailed query required no
direction query   no
filter query   no
guids query   yes
hypervisor query   no
hypervisor-cluster query   no
hypervisor-manager query   no
hypervisor-manager-type query "AWS" or "AZURE" or "FUSIONCOMPUTE" or "GCP" or "HC3" or "HYPERV" or "KUBERNETES" or "NUTANIX" or "OPENNEBULA" or "OPENSHIFT" or "OPENSTACK" or "ORACLE" or "RHEV" or "RHV" or "VCENTER" or "VIRTUOZZO" yes
hypervisor-type query "CITRIX" or "ESXI" or "HYPERV" or "KUBERNETES" or "KVM" or "NUTANIX" or "OPENSHIFT" or "OVM" or "PROXMOX" or "XEN" yes
nameLike query   no
nodeConfig query   no
orderBy query   no
page query   no
present query boolean no
project-uuid query   no
size query   no
snapshotPolicy query   no
snapshotable query boolean no
uuid query   no
uuids query   yes
vmPolicy query   yes
Response Body
media type data type description
application/json array of VirtualMachineDetails (JSON) detailed list of virtual machines filtered by specified query parameters

Example

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

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

                
[ {
  "sshHost" : "...",
  "sshPort" : 12345,
  "credential" : {
    "guid" : "...",
    "name" : "...",
    "user" : "...",
    "secretKey" : "...",
    "sshKey" : "...",
    "sshKeyPath" : "...",
    "powerShellTransportType" : "CERTIFICATE"
  },
  "sshKeyPath" : "...",
  "backupCount" : 12345,
  "rules" : [ {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  }, {
    "guid" : "...",
    "name" : "..."
  } ],
  "name" : "...",
  "type" : "CLOUD_USER",
  "backupUpToDate" : true,
  "restorable" : true,
  "lastSuccessfulBackupSize" : 12345,
  "lastSuccessfulFullBackupSize" : 12345,
  "warningsPresent" : true,
  "lastSuccessfulFullBackup" : {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  },
  "lastSuccessfulIncBackup" : {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  },
  "averageProgress" : 12345.0,
  "lastChainMarkedForDeletion" : true,
  "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
  "lastBackup" : 1451649601000,
  "uuid" : "...",
  "hypervisor" : {
    "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" : "SSH_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" : "LZO",
      "proxmoxNbdBufferReleaseMaxAttempts" : 12345,
      "proxmoxNbdBufferReleaseTimeout" : 12345,
      "proxmoxNbdBufferReleaseWaitPeriod" : 12345,
      "proxmoxAvailableNbdWaitPeriod" : 12345,
      "proxmoxConnectQcow2ToNbdWaitPeriod" : 12345
    },
    "hvHypervSettings" : {
      "hypervExportChunksNumber" : 12345,
      "hypevisorManagerHypervType" : "..."
    },
    "lastInventorySyncDate" : 12345,
    "lastSuccessfulInventorySyncDate" : 12345,
    "possibleActions" : [ "WRITE", "READ" ],
    "version" : "...",
    "trustAllCerts" : true,
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "type" : {
      "name" : "ENUM_NAME",
      "description" : "Enum description"
    }
  },
  "hvManager" : {
    "url" : "...",
    "sshPort" : 12345,
    "nodeConfig" : {
      "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
      "name" : "Entity name"
    },
    "user" : "...",
    "sshKeyPath" : "...",
    "hvCount" : 12345,
    "vmCount" : 12345,
    "vmExportImportMode" : "INHERIT",
    "baseImageCreationConfig" : {
      "windowsImageRequired" : "TRUE",
      "linuxImageRequired" : "TRUE"
    },
    "account" : "...",
    "useNetcat" : true,
    "storageType" : "DEFAULT",
    "region" : "...",
    "endpointInterfaceType" : "INTERNAL",
    "ovmSettings" : {
      "ovmJobStatusPollingInterval" : 12345,
      "ovmPoolToRepoMappings" : [ { }, { } ],
      "ovmExportCloneTypeOverride" : "SPARSE_COPY"
    },
    "rhvSettings" : {
      "rhvSnapshotCloneTimeout" : 12345,
      "rhvSnapshotCreationTimeout" : 12345,
      "rhvVmExportTimeout" : 12345,
      "rhvDiskUnlockTimeout" : 12345,
      "rhvMultiDatacenterExport" : true,
      "rhvSnapshotRemovalTimeout" : 12345,
      "rhvDcToSdMappings" : [ { }, { } ]
    },
    "awsSettings" : {
      "awsSnapshotCreationTimeout" : 12345,
      "awsImageCreationTimeout" : 12345,
      "awsVolumeActionsTimeout" : 12345,
      "awsInstanceCreationTimeout" : 12345
    },
    "vmwareSettings" : {
      "vmwareTagCategory" : "..."
    },
    "openStackSettings" : {
      "openstackDownloadImageFromGlance" : true,
      "openstackScopeVmsToDomain" : true
    },
    "nutanixSettings" : {
      "nutanixSnapshotRemovalTimeout" : 12345,
      "maxNutanixSnapshotCreatingTimeout" : 12345,
      "nutanixDiskOperationTimeout" : 12345
    },
    "oadpSettings" : {
      "oadpProjectName" : "...",
      "oadpStorageClassName" : "..."
    },
    "hvmHypervSettings" : {
      "hypervExportChunksNumber" : 12345,
      "hypevisorManagerHypervType" : "..."
    },
    "hvmAzureSettings" : {
      "azureClientId" : "...",
      "azureClientSecret" : "...",
      "azureSubscriptionId" : "...",
      "azureTenantId" : "..."
    },
    "gcpSettings" : {
      "gcpOrganizationId" : "..."
    },
    "useToken" : true,
    "lastInventorySyncDate" : 12345,
    "lastSuccessfulInventorySyncDate" : 12345,
    "possibleActions" : [ "WRITE", "INVENTORY_SYNC" ],
    "version" : "...",
    "trustAllCerts" : true,
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "type" : {
      "name" : "ENUM_NAME",
      "description" : "Enum description"
    }
  },
  "resourceGroup" : {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  },
  "vmBackupPolicy" : {
    "rules" : [ {
      "guid" : "...",
      "name" : "...",
      "policy" : { },
      "schedules" : [ { }, { } ],
      "vmCount" : 12345,
      "schedulesCount" : 12345,
      "position" : 12345,
      "active" : true,
      "removable" : true,
      "daysToKeepRetentionLock" : 12345
    }, {
      "guid" : "...",
      "name" : "...",
      "policy" : { },
      "schedules" : [ { }, { } ],
      "vmCount" : 12345,
      "schedulesCount" : 12345,
      "position" : 12345,
      "active" : true,
      "removable" : true,
      "daysToKeepRetentionLock" : 12345
    } ],
    "name" : "...",
    "active" : true,
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "priority" : 50,
    "autoAssignSettings" : {
      "mode" : "ASSIGN_AND_REMOVE",
      "includeRegExps" : [ "...", "..." ],
      "excludeRegExps" : [ "...", "..." ],
      "includeTags" : [ "...", "..." ],
      "excludeTags" : [ "...", "..." ],
      "hvClusters" : [ { }, { } ],
      "projects" : [ { }, { } ]
    },
    "autoRemoveNonPresent" : true,
    "vms" : [ {
      "name" : "...",
      "type" : "CLOUD",
      "backupUpToDate" : true,
      "restorable" : true,
      "uuid" : "...",
      "hypervisor" : { },
      "lastSuccessfulBackupSize" : 12345,
      "hvManager" : { },
      "lastSuccessfulFullBackupSize" : 12345,
      "dataCenter" : { },
      "warningsPresent" : true,
      "hvCluster" : { },
      "lastSuccessfulFullBackup" : { },
      "vmBackupPolicy" : { },
      "present" : true,
      "lastSuccessfulIncBackup" : { },
      "hvType" : "KVM",
      "averageProgress" : 12345.0,
      "lastChainMarkedForDeletion" : true,
      "hvmType" : "OPENSTACK",
      "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
      "project" : { },
      "lastBackup" : 1451649601000,
      "originalName" : "...",
      "restoreStatus" : "...",
      "possibleActions" : [ "READ", "INVENTORY_SYNC" ],
      "rule" : { },
      "vmFlavor" : { },
      "accessKey" : { },
      "networks" : [ { }, { } ],
      "supportsQuiesceSnapshot" : true
    }, {
      "name" : "...",
      "type" : "CLOUD_GROUP",
      "backupUpToDate" : true,
      "restorable" : true,
      "uuid" : "...",
      "hypervisor" : { },
      "lastSuccessfulBackupSize" : 12345,
      "hvManager" : { },
      "lastSuccessfulFullBackupSize" : 12345,
      "dataCenter" : { },
      "warningsPresent" : true,
      "hvCluster" : { },
      "lastSuccessfulFullBackup" : { },
      "vmBackupPolicy" : { },
      "present" : true,
      "lastSuccessfulIncBackup" : { },
      "hvType" : "KVM",
      "averageProgress" : 12345.0,
      "lastChainMarkedForDeletion" : true,
      "hvmType" : "KUBERNETES",
      "guid" : "...",
      "project" : { },
      "lastBackup" : 12345,
      "originalName" : "...",
      "restoreStatus" : "...",
      "possibleActions" : [ "WRITE", "READ" ],
      "rule" : { },
      "vmFlavor" : { },
      "accessKey" : { },
      "networks" : [ { }, { } ],
      "supportsQuiesceSnapshot" : true
    } ],
    "averageBackupSize" : 12345,
    "failRemainingBackupTasksExportThreshold" : 12345.0,
    "failRemainingBackupTasksStoreThreshold" : 12345.0,
    "projects" : [ {
      "guid" : "...",
      "name" : "...",
      "hvManager" : { },
      "uuid" : "..."
    }, {
      "guid" : "...",
      "name" : "...",
      "hvManager" : { },
      "uuid" : "..."
    } ],
    "visibleForAllProjects" : true,
    "backupRetryCount" : 12345,
    "dailyReportEnabled" : true,
    "mailingList" : {
      "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
      "name" : "Entity name"
    },
    "disableCleanOldBackups" : true,
    "quiesceBeforeSnapshot" : true
  },
  "snapshotMgmtPolicy" : {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  },
  "present" : true,
  "dataCenter" : {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  },
  "hvCluster" : {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  },
  "tags" : [ "...", "..." ],
  "hvType" : "KVM",
  "hvmType" : "OPENSTACK",
  "vmExportImportMode" : "DISK_ATTACHMENT",
  "preCommand" : {
    "commandArgs" : [ "...", "..." ],
    "commandType" : "SSH",
    "executionStage" : "PRE"
  },
  "postCommand" : {
    "commandArgs" : [ "...", "..." ],
    "commandType" : "SSH",
    "executionStage" : "POST"
  },
  "preSnapCmdExecEnabled" : true,
  "postSnapCmdExecEnabled" : true,
  "preSnapIgnoredExitCodes" : "...",
  "postSnapIgnoredExitCodes" : "...",
  "preSnapStdErrorHandling" : "IGNORE_WITH_WARNING",
  "postSnapStdErrorHandling" : "DONT_IGNORE",
  "preSnapCmdExecTimeout" : 12345,
  "postSnapCmdExecTimeout" : 12345,
  "baseImageCreationConfig" : {
    "windowsImageRequired" : "INHERIT",
    "linuxImageRequired" : "FALSE"
  },
  "project" : {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  },
  "externalReference" : "...",
  "originalName" : "...",
  "possibleActions" : [ "HV_READ", "READ" ],
  "networkInterfaceCards" : [ {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  }, {
    "guid" : "...",
    "name" : "..."
  } ],
  "lastStoredSnapshotAssignments" : [ {
    "protectedEntitySnapshot" : {
      "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
      "name" : "Entity name"
    },
    "virtualMachine" : {
      "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
      "name" : "Entity name"
    },
    "backupRule" : {
      "guid" : "...",
      "name" : "...",
      "policy" : { },
      "schedules" : [ { }, { } ],
      "ruleBackupDestinations" : [ { }, { } ],
      "vmCount" : 12345,
      "schedulesCount" : 12345,
      "position" : 12345,
      "active" : true,
      "backupCount" : 12345,
      "removable" : true,
      "markedForDeletion" : true,
      "daysToKeepRetentionLock" : 12345
    }
  }, {
    "protectedEntitySnapshot" : {
      "guid" : "...",
      "name" : "..."
    },
    "virtualMachine" : {
      "guid" : "...",
      "name" : "..."
    },
    "backupRule" : {
      "guid" : "...",
      "name" : "...",
      "policy" : { },
      "schedules" : [ { }, { } ],
      "ruleBackupDestinations" : [ { }, { } ],
      "vmCount" : 12345,
      "schedulesCount" : 12345,
      "position" : 12345,
      "active" : true,
      "backupCount" : 12345,
      "removable" : true,
      "markedForDeletion" : true,
      "daysToKeepRetentionLock" : 12345
    }
  } ],
  "vmResourceType" : "STATEFUL_SET",
  "vmFlavor" : {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  },
  "accessKey" : {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  }
} ]
                
              

POST /virtual-machines/details

Request Body
media type data type
application/json VirtualMachineQueryParameters (JSON)
Response Body
media type data type description
application/json array of VirtualMachineListRecord (JSON)

Example

Request
POST /virtual-machines/details
Content-Type: application/json
Accept: application/json

                
{
  "page" : "...",
  "size" : "...",
  "nameLike" : "...",
  "filter" : "...",
  "orderByField" : "...",
  "orderDirection" : "...",
  "hypervisor" : "...",
  "filterOrNameLike" : "...",
  "hvManager" : "...",
  "hvCluster" : "...",
  "dataCenter" : "...",
  "orderRequestCorrect" : true,
  "vmBackupPolicies" : [ "...", "..." ],
  "snapshotMgmtPolicy" : "...",
  "snapshotable" : true,
  "hvmTypes" : [ "VIRTUOZZO", "NUTANIX" ],
  "hvTypes" : [ "KUBERNETES", "HYPERV" ],
  "projectUuid" : "...",
  "uuid" : "...",
  "backupUpToDateStatuses" : [ "IS_PROTECTED", "NOT_PROTECTED" ],
  "nodeConfig" : "...",
  "present" : true,
  "uuids" : [ "...", "..." ],
  "guids" : [ "...", "..." ],
  "authenticationDomain" : "...",
  "detailed" : true
}
                
              
Response
HTTP/1.1 201 Created
Content-Type: application/json

                
[ {
  "name" : "...",
  "type" : "OS",
  "backupUpToDate" : true,
  "restorable" : true,
  "uuid" : "...",
  "hypervisor" : {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  },
  "lastSuccessfulBackupSize" : 12345,
  "hvManager" : {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  },
  "lastSuccessfulFullBackupSize" : 12345,
  "dataCenter" : {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  },
  "warningsPresent" : true,
  "hvCluster" : {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  },
  "lastSuccessfulFullBackup" : {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  },
  "vmBackupPolicy" : {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  },
  "present" : true,
  "lastSuccessfulIncBackup" : {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  },
  "hvType" : "KVM",
  "averageProgress" : 12345.0,
  "lastChainMarkedForDeletion" : true,
  "hvmType" : "OPENSTACK",
  "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
  "project" : {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  },
  "lastBackup" : 1451649601000,
  "originalName" : "...",
  "restoreStatus" : "...",
  "possibleActions" : [ "HV_READ", "INVENTORY_SYNC" ],
  "rule" : {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  },
  "vmFlavor" : {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  },
  "accessKey" : {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  },
  "networks" : [ {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  }, {
    "guid" : "...",
    "name" : "..."
  } ],
  "supportsQuiesceSnapshot" : true
} ]
                
              

GET /virtual-machines/identifiers

Returns detailed list of virtual machines filtered by specified query parameters.

Request Parameters
name type description constraints multivalued
authentication-domain query   no
backupStatus query "IS_PROTECTED" or "NOT_PROTECTED" or "NO_SCHEDULE" yes
data-center query   no
detailed query required no
direction query   no
filter query   no
guids query   yes
hypervisor query   no
hypervisor-cluster query   no
hypervisor-manager query   no
hypervisor-manager-type query "AWS" or "AZURE" or "FUSIONCOMPUTE" or "GCP" or "HC3" or "HYPERV" or "KUBERNETES" or "NUTANIX" or "OPENNEBULA" or "OPENSHIFT" or "OPENSTACK" or "ORACLE" or "RHEV" or "RHV" or "VCENTER" or "VIRTUOZZO" yes
hypervisor-type query "CITRIX" or "ESXI" or "HYPERV" or "KUBERNETES" or "KVM" or "NUTANIX" or "OPENSHIFT" or "OVM" or "PROXMOX" or "XEN" yes
nameLike query   no
nodeConfig query   no
orderBy query   no
page query   no
present query boolean no
project-uuid query   no
size query   no
snapshotPolicy query   no
snapshotable query boolean no
uuid query   no
uuids query   yes
vmPolicy query   yes
Response Body
media type data type description
application/json array of VirtualMachineIdentifierListRecord (JSON) detailed list of virtual machines filtered by specified query parameters

Example

Request
GET /virtual-machines/identifiers
Content-Type: */*
Accept: application/json

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

                
[ {
  "uuid" : "...",
  "guid" : "...",
  "name" : "..."
} ]
                
              

POST /virtual-machines/incremental-not-possible

Get all virtual machines that are not able to proceed incremental backup.

Request Body
media type data type
application/json VirtualMachineList (JSON)
Response Body
media type data type description
application/json array of VirtualMachineAndIssuesDetails (JSON)

Example

Request
POST /virtual-machines/incremental-not-possible
Content-Type: application/json
Accept: application/json

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

                
[ {
  "virtualMachine" : {
    "sshHost" : "...",
    "sshPort" : 12345,
    "credential" : {
      "guid" : "...",
      "name" : "...",
      "user" : "...",
      "secretKey" : "...",
      "sshKey" : "...",
      "sshKeyPath" : "...",
      "powerShellTransportType" : "CREDSSP"
    },
    "sshKeyPath" : "...",
    "backupCount" : 12345,
    "rules" : [ {
      "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
      "name" : "Entity name"
    }, {
      "guid" : "...",
      "name" : "..."
    } ],
    "name" : "...",
    "type" : "CLOUD_TEAMS",
    "backupUpToDate" : true,
    "restorable" : true,
    "lastSuccessfulBackupSize" : 12345,
    "lastSuccessfulFullBackupSize" : 12345,
    "warningsPresent" : true,
    "lastSuccessfulFullBackup" : {
      "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
      "name" : "Entity name"
    },
    "lastSuccessfulIncBackup" : {
      "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
      "name" : "Entity name"
    },
    "averageProgress" : 12345.0,
    "lastChainMarkedForDeletion" : true,
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "lastBackup" : 1451649601000,
    "uuid" : "...",
    "hypervisor" : {
      "host" : "...",
      "sshPort" : 12345,
      "nodeConfig" : { },
      "user" : "...",
      "sshKeyPath" : "...",
      "vmCount" : 12345,
      "hvManager" : { },
      "hvmType" : { },
      "vmExportImportMode" : "INHERIT",
      "transferNicAddress" : "...",
      "dataCenterName" : "...",
      "cluster" : { },
      "vmOwner" : "...",
      "vmOwningGroup" : "...",
      "storageType" : "CEPH",
      "storageProvider" : { },
      "licenseCovered" : true,
      "useNetcat" : true,
      "citrixSettings" : { },
      "libvirtSettings" : { },
      "proxmoxSettings" : { },
      "hvHypervSettings" : { },
      "lastInventorySyncDate" : 12345,
      "lastSuccessfulInventorySyncDate" : 12345,
      "possibleActions" : [ "HV_READ", "HV_READ" ],
      "version" : "...",
      "trustAllCerts" : true,
      "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
      "type" : { }
    },
    "hvManager" : {
      "url" : "...",
      "sshPort" : 12345,
      "nodeConfig" : { },
      "user" : "...",
      "sshKeyPath" : "...",
      "hvCount" : 12345,
      "vmCount" : 12345,
      "vmExportImportMode" : "DISK_IMAGE_TRANSFER",
      "baseImageCreationConfig" : { },
      "account" : "...",
      "useNetcat" : true,
      "storageType" : "DEFAULT",
      "region" : "...",
      "endpointInterfaceType" : "INTERNAL",
      "ovmSettings" : { },
      "rhvSettings" : { },
      "awsSettings" : { },
      "vmwareSettings" : { },
      "openStackSettings" : { },
      "nutanixSettings" : { },
      "oadpSettings" : { },
      "hvmHypervSettings" : { },
      "hvmAzureSettings" : { },
      "gcpSettings" : { },
      "useToken" : true,
      "lastInventorySyncDate" : 12345,
      "lastSuccessfulInventorySyncDate" : 12345,
      "possibleActions" : [ "WRITE", "INVENTORY_SYNC" ],
      "version" : "...",
      "trustAllCerts" : true,
      "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
      "type" : { }
    },
    "resourceGroup" : {
      "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
      "name" : "Entity name"
    },
    "vmBackupPolicy" : {
      "rules" : [ { }, { } ],
      "name" : "...",
      "active" : true,
      "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
      "priority" : 50,
      "autoAssignSettings" : { },
      "autoRemoveNonPresent" : true,
      "vms" : [ { }, { } ],
      "averageBackupSize" : 12345,
      "failRemainingBackupTasksExportThreshold" : 12345.0,
      "failRemainingBackupTasksStoreThreshold" : 12345.0,
      "projects" : [ { }, { } ],
      "visibleForAllProjects" : true,
      "backupRetryCount" : 12345,
      "dailyReportEnabled" : true,
      "mailingList" : { },
      "disableCleanOldBackups" : true,
      "quiesceBeforeSnapshot" : true
    },
    "snapshotMgmtPolicy" : {
      "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
      "name" : "Entity name"
    },
    "present" : true,
    "dataCenter" : {
      "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
      "name" : "Entity name"
    },
    "hvCluster" : {
      "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
      "name" : "Entity name"
    },
    "tags" : [ "...", "..." ],
    "hvType" : "KVM",
    "hvmType" : "OPENSTACK",
    "vmExportImportMode" : "SSH_TRANSFER",
    "preCommand" : {
      "commandArgs" : [ "...", "..." ],
      "commandType" : "POWERSHELL",
      "executionStage" : "PRE"
    },
    "postCommand" : {
      "commandArgs" : [ "...", "..." ],
      "commandType" : "POWERSHELL",
      "executionStage" : "POST"
    },
    "preSnapCmdExecEnabled" : true,
    "postSnapCmdExecEnabled" : true,
    "preSnapIgnoredExitCodes" : "...",
    "postSnapIgnoredExitCodes" : "...",
    "preSnapStdErrorHandling" : "IGNORE_WITHOUT_WARNING",
    "postSnapStdErrorHandling" : "IGNORE_WITH_WARNING",
    "preSnapCmdExecTimeout" : 12345,
    "postSnapCmdExecTimeout" : 12345,
    "baseImageCreationConfig" : {
      "windowsImageRequired" : "TRUE",
      "linuxImageRequired" : "FALSE"
    },
    "project" : {
      "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
      "name" : "Entity name"
    },
    "externalReference" : "...",
    "originalName" : "...",
    "possibleActions" : [ "INVENTORY_SYNC", "HV_READ" ],
    "networkInterfaceCards" : [ {
      "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
      "name" : "Entity name"
    }, {
      "guid" : "...",
      "name" : "..."
    } ],
    "lastStoredSnapshotAssignments" : [ {
      "protectedEntitySnapshot" : { },
      "virtualMachine" : { },
      "backupRule" : { }
    }, {
      "protectedEntitySnapshot" : { },
      "virtualMachine" : { },
      "backupRule" : { }
    } ],
    "vmResourceType" : "UNDEFINED",
    "vmFlavor" : {
      "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
      "name" : "Entity name"
    },
    "accessKey" : {
      "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
      "name" : "Entity name"
    }
  },
  "reasons" : [ "MISSING_INCREMENTAL_SCHEDULER", "MISSING_FULL_BACKUP_AND_SCHEDULER" ]
} ]
                
              

GET /virtual-machines/policy-assignment-statuses

Request Parameters
name type description
direction query
filter query
name query
nameLike query
orderBy query
page query
size query
Response Body
media type data type description
application/json array of ProtectedEntityPolicyAssignmentStatusRecord (JSON)

Example

Request
GET /virtual-machines/policy-assignment-statuses
Content-Type: */*
Accept: application/json

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

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

GET /virtual-machines/rbac-contexts

Returns list of virtual machines 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 virtual machines filtered by specified query parameters

Example

Request
GET /virtual-machines/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" : "CLOUD_SITE",
  "checked" : true,
  "lastLevel" : true,
  "present" : true,
  "entityType" : "...",
  "childrenQueryType" : "..."
} ]
                
              

GET /virtual-machines/{guid}

Get a single virtual machine details.

Request Parameters
name type description
guid path specify local unique identifier for virtual machine (use by vProtect)
Response Body
media type data type description
application/json VirtualMachineDetails (JSON) a single virtual machine details

Example

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

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

                
{
  "sshHost" : "...",
  "sshPort" : 12345,
  "credential" : {
    "guid" : "...",
    "name" : "...",
    "user" : "...",
    "secretKey" : "...",
    "sshKey" : "...",
    "sshKeyPath" : "...",
    "powerShellTransportType" : "KERBEROS"
  },
  "sshKeyPath" : "...",
  "backupCount" : 12345,
  "rules" : [ {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  }, {
    "guid" : "...",
    "name" : "..."
  } ],
  "name" : "...",
  "type" : "OS_AGENT",
  "backupUpToDate" : true,
  "restorable" : true,
  "lastSuccessfulBackupSize" : 12345,
  "lastSuccessfulFullBackupSize" : 12345,
  "warningsPresent" : true,
  "lastSuccessfulFullBackup" : {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  },
  "lastSuccessfulIncBackup" : {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  },
  "averageProgress" : 12345.0,
  "lastChainMarkedForDeletion" : true,
  "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
  "lastBackup" : 1451649601000,
  "uuid" : "...",
  "hypervisor" : {
    "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" : "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" : "DISABLED",
      "proxmoxNbdBufferReleaseMaxAttempts" : 12345,
      "proxmoxNbdBufferReleaseTimeout" : 12345,
      "proxmoxNbdBufferReleaseWaitPeriod" : 12345,
      "proxmoxAvailableNbdWaitPeriod" : 12345,
      "proxmoxConnectQcow2ToNbdWaitPeriod" : 12345
    },
    "hvHypervSettings" : {
      "hypervExportChunksNumber" : 12345,
      "hypevisorManagerHypervType" : "..."
    },
    "lastInventorySyncDate" : 12345,
    "lastSuccessfulInventorySyncDate" : 12345,
    "possibleActions" : [ "HV_READ", "HV_READ" ],
    "version" : "...",
    "trustAllCerts" : true,
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "type" : {
      "name" : "ENUM_NAME",
      "description" : "Enum description"
    }
  },
  "hvManager" : {
    "url" : "...",
    "sshPort" : 12345,
    "nodeConfig" : {
      "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
      "name" : "Entity name"
    },
    "user" : "...",
    "sshKeyPath" : "...",
    "hvCount" : 12345,
    "vmCount" : 12345,
    "vmExportImportMode" : "INHERIT",
    "baseImageCreationConfig" : {
      "windowsImageRequired" : "FALSE",
      "linuxImageRequired" : "TRUE"
    },
    "account" : "...",
    "useNetcat" : true,
    "storageType" : "DEFAULT",
    "region" : "...",
    "endpointInterfaceType" : "PUBLIC",
    "ovmSettings" : {
      "ovmJobStatusPollingInterval" : 12345,
      "ovmPoolToRepoMappings" : [ { }, { } ],
      "ovmExportCloneTypeOverride" : "NON_SPARSE_COPY"
    },
    "rhvSettings" : {
      "rhvSnapshotCloneTimeout" : 12345,
      "rhvSnapshotCreationTimeout" : 12345,
      "rhvVmExportTimeout" : 12345,
      "rhvDiskUnlockTimeout" : 12345,
      "rhvMultiDatacenterExport" : true,
      "rhvSnapshotRemovalTimeout" : 12345,
      "rhvDcToSdMappings" : [ { }, { } ]
    },
    "awsSettings" : {
      "awsSnapshotCreationTimeout" : 12345,
      "awsImageCreationTimeout" : 12345,
      "awsVolumeActionsTimeout" : 12345,
      "awsInstanceCreationTimeout" : 12345
    },
    "vmwareSettings" : {
      "vmwareTagCategory" : "..."
    },
    "openStackSettings" : {
      "openstackDownloadImageFromGlance" : true,
      "openstackScopeVmsToDomain" : true
    },
    "nutanixSettings" : {
      "nutanixSnapshotRemovalTimeout" : 12345,
      "maxNutanixSnapshotCreatingTimeout" : 12345,
      "nutanixDiskOperationTimeout" : 12345
    },
    "oadpSettings" : {
      "oadpProjectName" : "...",
      "oadpStorageClassName" : "..."
    },
    "hvmHypervSettings" : {
      "hypervExportChunksNumber" : 12345,
      "hypevisorManagerHypervType" : "..."
    },
    "hvmAzureSettings" : {
      "azureClientId" : "...",
      "azureClientSecret" : "...",
      "azureSubscriptionId" : "...",
      "azureTenantId" : "..."
    },
    "gcpSettings" : {
      "gcpOrganizationId" : "..."
    },
    "useToken" : true,
    "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"
    }
  },
  "resourceGroup" : {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  },
  "vmBackupPolicy" : {
    "rules" : [ {
      "guid" : "...",
      "name" : "...",
      "policy" : { },
      "schedules" : [ { }, { } ],
      "vmCount" : 12345,
      "schedulesCount" : 12345,
      "position" : 12345,
      "active" : true,
      "removable" : true,
      "daysToKeepRetentionLock" : 12345
    }, {
      "guid" : "...",
      "name" : "...",
      "policy" : { },
      "schedules" : [ { }, { } ],
      "vmCount" : 12345,
      "schedulesCount" : 12345,
      "position" : 12345,
      "active" : true,
      "removable" : true,
      "daysToKeepRetentionLock" : 12345
    } ],
    "name" : "...",
    "active" : true,
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "priority" : 50,
    "autoAssignSettings" : {
      "mode" : "ASSIGN_ONLY",
      "includeRegExps" : [ "...", "..." ],
      "excludeRegExps" : [ "...", "..." ],
      "includeTags" : [ "...", "..." ],
      "excludeTags" : [ "...", "..." ],
      "hvClusters" : [ { }, { } ],
      "projects" : [ { }, { } ]
    },
    "autoRemoveNonPresent" : true,
    "vms" : [ {
      "name" : "...",
      "type" : "CLOUD",
      "backupUpToDate" : true,
      "restorable" : true,
      "uuid" : "...",
      "hypervisor" : { },
      "lastSuccessfulBackupSize" : 12345,
      "hvManager" : { },
      "lastSuccessfulFullBackupSize" : 12345,
      "dataCenter" : { },
      "warningsPresent" : true,
      "hvCluster" : { },
      "lastSuccessfulFullBackup" : { },
      "vmBackupPolicy" : { },
      "present" : true,
      "lastSuccessfulIncBackup" : { },
      "hvType" : "KVM",
      "averageProgress" : 12345.0,
      "lastChainMarkedForDeletion" : true,
      "hvmType" : "OPENSTACK",
      "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
      "project" : { },
      "lastBackup" : 1451649601000,
      "originalName" : "...",
      "restoreStatus" : "...",
      "possibleActions" : [ "INVENTORY_SYNC", "INVENTORY_SYNC" ],
      "rule" : { },
      "vmFlavor" : { },
      "accessKey" : { },
      "networks" : [ { }, { } ],
      "supportsQuiesceSnapshot" : true
    }, {
      "name" : "...",
      "type" : "CLOUD_GROUP",
      "backupUpToDate" : true,
      "restorable" : true,
      "uuid" : "...",
      "hypervisor" : { },
      "lastSuccessfulBackupSize" : 12345,
      "hvManager" : { },
      "lastSuccessfulFullBackupSize" : 12345,
      "dataCenter" : { },
      "warningsPresent" : true,
      "hvCluster" : { },
      "lastSuccessfulFullBackup" : { },
      "vmBackupPolicy" : { },
      "present" : true,
      "lastSuccessfulIncBackup" : { },
      "hvType" : "XEN",
      "averageProgress" : 12345.0,
      "lastChainMarkedForDeletion" : true,
      "hvmType" : "KUBERNETES",
      "guid" : "...",
      "project" : { },
      "lastBackup" : 12345,
      "originalName" : "...",
      "restoreStatus" : "...",
      "possibleActions" : [ "INVENTORY_SYNC", "HV_READ" ],
      "rule" : { },
      "vmFlavor" : { },
      "accessKey" : { },
      "networks" : [ { }, { } ],
      "supportsQuiesceSnapshot" : true
    } ],
    "averageBackupSize" : 12345,
    "failRemainingBackupTasksExportThreshold" : 12345.0,
    "failRemainingBackupTasksStoreThreshold" : 12345.0,
    "projects" : [ {
      "guid" : "...",
      "name" : "...",
      "hvManager" : { },
      "uuid" : "..."
    }, {
      "guid" : "...",
      "name" : "...",
      "hvManager" : { },
      "uuid" : "..."
    } ],
    "visibleForAllProjects" : true,
    "backupRetryCount" : 12345,
    "dailyReportEnabled" : true,
    "mailingList" : {
      "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
      "name" : "Entity name"
    },
    "disableCleanOldBackups" : true,
    "quiesceBeforeSnapshot" : true
  },
  "snapshotMgmtPolicy" : {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  },
  "present" : true,
  "dataCenter" : {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  },
  "hvCluster" : {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  },
  "tags" : [ "...", "..." ],
  "hvType" : "KVM",
  "hvmType" : "OPENSTACK",
  "vmExportImportMode" : "INHERIT",
  "preCommand" : {
    "commandArgs" : [ "...", "..." ],
    "commandType" : "POWERSHELL",
    "executionStage" : "POST"
  },
  "postCommand" : {
    "commandArgs" : [ "...", "..." ],
    "commandType" : "POWERSHELL",
    "executionStage" : "POST"
  },
  "preSnapCmdExecEnabled" : true,
  "postSnapCmdExecEnabled" : true,
  "preSnapIgnoredExitCodes" : "...",
  "postSnapIgnoredExitCodes" : "...",
  "preSnapStdErrorHandling" : "DONT_IGNORE",
  "postSnapStdErrorHandling" : "IGNORE_WITHOUT_WARNING",
  "preSnapCmdExecTimeout" : 12345,
  "postSnapCmdExecTimeout" : 12345,
  "baseImageCreationConfig" : {
    "windowsImageRequired" : "FALSE",
    "linuxImageRequired" : "INHERIT"
  },
  "project" : {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  },
  "externalReference" : "...",
  "originalName" : "...",
  "possibleActions" : [ "INVENTORY_SYNC", "READ" ],
  "networkInterfaceCards" : [ {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  }, {
    "guid" : "...",
    "name" : "..."
  } ],
  "lastStoredSnapshotAssignments" : [ {
    "protectedEntitySnapshot" : {
      "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
      "name" : "Entity name"
    },
    "virtualMachine" : {
      "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
      "name" : "Entity name"
    },
    "backupRule" : {
      "guid" : "...",
      "name" : "...",
      "policy" : { },
      "schedules" : [ { }, { } ],
      "ruleBackupDestinations" : [ { }, { } ],
      "vmCount" : 12345,
      "schedulesCount" : 12345,
      "position" : 12345,
      "active" : true,
      "backupCount" : 12345,
      "removable" : true,
      "markedForDeletion" : true,
      "daysToKeepRetentionLock" : 12345
    }
  }, {
    "protectedEntitySnapshot" : {
      "guid" : "...",
      "name" : "..."
    },
    "virtualMachine" : {
      "guid" : "...",
      "name" : "..."
    },
    "backupRule" : {
      "guid" : "...",
      "name" : "...",
      "policy" : { },
      "schedules" : [ { }, { } ],
      "ruleBackupDestinations" : [ { }, { } ],
      "vmCount" : 12345,
      "schedulesCount" : 12345,
      "position" : 12345,
      "active" : true,
      "backupCount" : 12345,
      "removable" : true,
      "markedForDeletion" : true,
      "daysToKeepRetentionLock" : 12345
    }
  } ],
  "vmResourceType" : "VIRTUAL_MACHINE",
  "vmFlavor" : {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  },
  "accessKey" : {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  }
}
                
              

PUT /virtual-machines/{guid}/settings

Change virtual machine settings.

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

Example

Request
PUT /virtual-machines/{guid}/settings
Content-Type: application/json
Accept: application/json

                
{
  "vmExportImportMode" : "SSH_TRANSFER",
  "sshHost" : "...",
  "sshPort" : 12345,
  "sshUser" : "...",
  "sshKeyPath" : "...",
  "preCommand" : {
    "commandArgs" : [ "...", "..." ],
    "commandType" : "POWERSHELL",
    "executionStage" : "PRE"
  },
  "postCommand" : {
    "commandArgs" : [ "...", "..." ],
    "commandType" : "POWERSHELL",
    "executionStage" : "POST"
  },
  "preSnapCmdExecEnabled" : true,
  "postSnapCmdExecEnabled" : true,
  "preSnapStdErrorHandling" : "IGNORE_WITHOUT_WARNING",
  "postSnapStdErrorHandling" : "IGNORE_WITHOUT_WARNING",
  "preSnapCmdExecTimeout" : 12345,
  "postSnapCmdExecTimeout" : 12345,
  "preSnapIgnoredExitCodes" : "...",
  "postSnapIgnoredExitCodes" : "...",
  "vmBackupPolicy" : {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  },
  "snapshotMgmtPolicy" : {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  },
  "baseImageCreationConfig" : {
    "windowsImageRequired" : "TRUE",
    "linuxImageRequired" : "INHERIT"
  },
  "credential" : {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  }
}
                
              
Response
HTTP/1.1 204 No Content
Content-Type: application/json

                
{
  "sshHost" : "...",
  "sshPort" : 12345,
  "credential" : {
    "guid" : "...",
    "name" : "...",
    "user" : "...",
    "secretKey" : "...",
    "sshKey" : "...",
    "sshKeyPath" : "...",
    "powerShellTransportType" : "KERBEROS"
  },
  "sshKeyPath" : "...",
  "backupCount" : 12345,
  "rules" : [ {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  }, {
    "guid" : "...",
    "name" : "..."
  } ],
  "name" : "...",
  "type" : "VM",
  "backupUpToDate" : true,
  "restorable" : true,
  "lastSuccessfulBackupSize" : 12345,
  "lastSuccessfulFullBackupSize" : 12345,
  "warningsPresent" : true,
  "lastSuccessfulFullBackup" : {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  },
  "lastSuccessfulIncBackup" : {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  },
  "averageProgress" : 12345.0,
  "lastChainMarkedForDeletion" : true,
  "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
  "lastBackup" : 1451649601000,
  "uuid" : "...",
  "hypervisor" : {
    "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" : "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" : [ "WRITE", "INVENTORY_SYNC" ],
    "version" : "...",
    "trustAllCerts" : true,
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "type" : {
      "name" : "ENUM_NAME",
      "description" : "Enum description"
    }
  },
  "hvManager" : {
    "url" : "...",
    "sshPort" : 12345,
    "nodeConfig" : {
      "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
      "name" : "Entity name"
    },
    "user" : "...",
    "sshKeyPath" : "...",
    "hvCount" : 12345,
    "vmCount" : 12345,
    "vmExportImportMode" : "EXPORT_STORAGE_REPO",
    "baseImageCreationConfig" : {
      "windowsImageRequired" : "TRUE",
      "linuxImageRequired" : "INHERIT"
    },
    "account" : "...",
    "useNetcat" : true,
    "storageType" : "DEFAULT",
    "region" : "...",
    "endpointInterfaceType" : "INTERNAL",
    "ovmSettings" : {
      "ovmJobStatusPollingInterval" : 12345,
      "ovmPoolToRepoMappings" : [ { }, { } ],
      "ovmExportCloneTypeOverride" : "SPARSE_COPY"
    },
    "rhvSettings" : {
      "rhvSnapshotCloneTimeout" : 12345,
      "rhvSnapshotCreationTimeout" : 12345,
      "rhvVmExportTimeout" : 12345,
      "rhvDiskUnlockTimeout" : 12345,
      "rhvMultiDatacenterExport" : true,
      "rhvSnapshotRemovalTimeout" : 12345,
      "rhvDcToSdMappings" : [ { }, { } ]
    },
    "awsSettings" : {
      "awsSnapshotCreationTimeout" : 12345,
      "awsImageCreationTimeout" : 12345,
      "awsVolumeActionsTimeout" : 12345,
      "awsInstanceCreationTimeout" : 12345
    },
    "vmwareSettings" : {
      "vmwareTagCategory" : "..."
    },
    "openStackSettings" : {
      "openstackDownloadImageFromGlance" : true,
      "openstackScopeVmsToDomain" : true
    },
    "nutanixSettings" : {
      "nutanixSnapshotRemovalTimeout" : 12345,
      "maxNutanixSnapshotCreatingTimeout" : 12345,
      "nutanixDiskOperationTimeout" : 12345
    },
    "oadpSettings" : {
      "oadpProjectName" : "...",
      "oadpStorageClassName" : "..."
    },
    "hvmHypervSettings" : {
      "hypervExportChunksNumber" : 12345,
      "hypevisorManagerHypervType" : "..."
    },
    "hvmAzureSettings" : {
      "azureClientId" : "...",
      "azureClientSecret" : "...",
      "azureSubscriptionId" : "...",
      "azureTenantId" : "..."
    },
    "gcpSettings" : {
      "gcpOrganizationId" : "..."
    },
    "useToken" : true,
    "lastInventorySyncDate" : 12345,
    "lastSuccessfulInventorySyncDate" : 12345,
    "possibleActions" : [ "WRITE", "HV_READ" ],
    "version" : "...",
    "trustAllCerts" : true,
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "type" : {
      "name" : "ENUM_NAME",
      "description" : "Enum description"
    }
  },
  "resourceGroup" : {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  },
  "vmBackupPolicy" : {
    "rules" : [ {
      "guid" : "...",
      "name" : "...",
      "policy" : { },
      "schedules" : [ { }, { } ],
      "vmCount" : 12345,
      "schedulesCount" : 12345,
      "position" : 12345,
      "active" : true,
      "removable" : true,
      "daysToKeepRetentionLock" : 12345
    }, {
      "guid" : "...",
      "name" : "...",
      "policy" : { },
      "schedules" : [ { }, { } ],
      "vmCount" : 12345,
      "schedulesCount" : 12345,
      "position" : 12345,
      "active" : true,
      "removable" : true,
      "daysToKeepRetentionLock" : 12345
    } ],
    "name" : "...",
    "active" : true,
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "priority" : 50,
    "autoAssignSettings" : {
      "mode" : "ASSIGN_ONLY",
      "includeRegExps" : [ "...", "..." ],
      "excludeRegExps" : [ "...", "..." ],
      "includeTags" : [ "...", "..." ],
      "excludeTags" : [ "...", "..." ],
      "hvClusters" : [ { }, { } ],
      "projects" : [ { }, { } ]
    },
    "autoRemoveNonPresent" : true,
    "vms" : [ {
      "name" : "...",
      "type" : "CLOUD_TEAMS",
      "backupUpToDate" : true,
      "restorable" : true,
      "uuid" : "...",
      "hypervisor" : { },
      "lastSuccessfulBackupSize" : 12345,
      "hvManager" : { },
      "lastSuccessfulFullBackupSize" : 12345,
      "dataCenter" : { },
      "warningsPresent" : true,
      "hvCluster" : { },
      "lastSuccessfulFullBackup" : { },
      "vmBackupPolicy" : { },
      "present" : true,
      "lastSuccessfulIncBackup" : { },
      "hvType" : "KVM",
      "averageProgress" : 12345.0,
      "lastChainMarkedForDeletion" : true,
      "hvmType" : "OPENSTACK",
      "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
      "project" : { },
      "lastBackup" : 1451649601000,
      "originalName" : "...",
      "restoreStatus" : "...",
      "possibleActions" : [ "READ", "INVENTORY_SYNC" ],
      "rule" : { },
      "vmFlavor" : { },
      "accessKey" : { },
      "networks" : [ { }, { } ],
      "supportsQuiesceSnapshot" : true
    }, {
      "name" : "...",
      "type" : "CLOUD_TEAMS",
      "backupUpToDate" : true,
      "restorable" : true,
      "uuid" : "...",
      "hypervisor" : { },
      "lastSuccessfulBackupSize" : 12345,
      "hvManager" : { },
      "lastSuccessfulFullBackupSize" : 12345,
      "dataCenter" : { },
      "warningsPresent" : true,
      "hvCluster" : { },
      "lastSuccessfulFullBackup" : { },
      "vmBackupPolicy" : { },
      "present" : true,
      "lastSuccessfulIncBackup" : { },
      "hvType" : "PROXMOX",
      "averageProgress" : 12345.0,
      "lastChainMarkedForDeletion" : true,
      "hvmType" : "HC3",
      "guid" : "...",
      "project" : { },
      "lastBackup" : 12345,
      "originalName" : "...",
      "restoreStatus" : "...",
      "possibleActions" : [ "INVENTORY_SYNC", "HV_READ" ],
      "rule" : { },
      "vmFlavor" : { },
      "accessKey" : { },
      "networks" : [ { }, { } ],
      "supportsQuiesceSnapshot" : true
    } ],
    "averageBackupSize" : 12345,
    "failRemainingBackupTasksExportThreshold" : 12345.0,
    "failRemainingBackupTasksStoreThreshold" : 12345.0,
    "projects" : [ {
      "guid" : "...",
      "name" : "...",
      "hvManager" : { },
      "uuid" : "..."
    }, {
      "guid" : "...",
      "name" : "...",
      "hvManager" : { },
      "uuid" : "..."
    } ],
    "visibleForAllProjects" : true,
    "backupRetryCount" : 12345,
    "dailyReportEnabled" : true,
    "mailingList" : {
      "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
      "name" : "Entity name"
    },
    "disableCleanOldBackups" : true,
    "quiesceBeforeSnapshot" : true
  },
  "snapshotMgmtPolicy" : {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  },
  "present" : true,
  "dataCenter" : {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  },
  "hvCluster" : {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  },
  "tags" : [ "...", "..." ],
  "hvType" : "KVM",
  "hvmType" : "OPENSTACK",
  "vmExportImportMode" : "SSH_TRANSFER",
  "preCommand" : {
    "commandArgs" : [ "...", "..." ],
    "commandType" : "SSH",
    "executionStage" : "PRE"
  },
  "postCommand" : {
    "commandArgs" : [ "...", "..." ],
    "commandType" : "SSH",
    "executionStage" : "POST"
  },
  "preSnapCmdExecEnabled" : true,
  "postSnapCmdExecEnabled" : true,
  "preSnapIgnoredExitCodes" : "...",
  "postSnapIgnoredExitCodes" : "...",
  "preSnapStdErrorHandling" : "IGNORE_WITH_WARNING",
  "postSnapStdErrorHandling" : "IGNORE_WITH_WARNING",
  "preSnapCmdExecTimeout" : 12345,
  "postSnapCmdExecTimeout" : 12345,
  "baseImageCreationConfig" : {
    "windowsImageRequired" : "FALSE",
    "linuxImageRequired" : "FALSE"
  },
  "project" : {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  },
  "externalReference" : "...",
  "originalName" : "...",
  "possibleActions" : [ "HV_READ", "READ" ],
  "networkInterfaceCards" : [ {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  }, {
    "guid" : "...",
    "name" : "..."
  } ],
  "lastStoredSnapshotAssignments" : [ {
    "protectedEntitySnapshot" : {
      "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
      "name" : "Entity name"
    },
    "virtualMachine" : {
      "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
      "name" : "Entity name"
    },
    "backupRule" : {
      "guid" : "...",
      "name" : "...",
      "policy" : { },
      "schedules" : [ { }, { } ],
      "ruleBackupDestinations" : [ { }, { } ],
      "vmCount" : 12345,
      "schedulesCount" : 12345,
      "position" : 12345,
      "active" : true,
      "backupCount" : 12345,
      "removable" : true,
      "markedForDeletion" : true,
      "daysToKeepRetentionLock" : 12345
    }
  }, {
    "protectedEntitySnapshot" : {
      "guid" : "...",
      "name" : "..."
    },
    "virtualMachine" : {
      "guid" : "...",
      "name" : "..."
    },
    "backupRule" : {
      "guid" : "...",
      "name" : "...",
      "policy" : { },
      "schedules" : [ { }, { } ],
      "ruleBackupDestinations" : [ { }, { } ],
      "vmCount" : 12345,
      "schedulesCount" : 12345,
      "position" : 12345,
      "active" : true,
      "backupCount" : 12345,
      "removable" : true,
      "markedForDeletion" : true,
      "daysToKeepRetentionLock" : 12345
    }
  } ],
  "vmResourceType" : "VIRTUAL_MACHINE",
  "vmFlavor" : {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  },
  "accessKey" : {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  }
}