HPE Developer Community Portal

Feature and function support by REST API version

The tables in this section list the features and functions that each version of the REST API supports for the following object types:

  • backup
  • certificates
  • datastore
  • host
  • omnistack_cluster
  • policy
  • task
  • virtual_machine

backup

The REST API supports the following features and functions for the backup object type:

Operation11.11.21.31.41.51.61.71.81.91.101.11
GETXXXXXXXXXXXX
Additional returned properties:
compute_cluster_parent_hypervisor_object_idXXXXXXXX
compute_cluster_parent_nameXXXXXXXX
consistency_typeXXXXXXXXX
hypervisor_typeXXXXXXX
sent_completion_timeXXXX
sent_durationXXXX
unique_size_bytesXXXXXXXX
unique_size_timestampXXXXXXXX
virtual_machine_stateXXXXXXXXXX
virtual_machine_typeXXXXXXXX
GET virtual_disksXXX
GET virtual_disk_partitionsXXX
GET virtual_disk_partition_filesXXX
DELETEXXXXXXXXXXXX
POST calculate_unique_sizeXXXXX
POST cancelXXXXX
POST copyXXXXXXXXXXX
POST deleteXXXXXXXX
POST lockXXXXXXXXXXX
POST renameXXXXXXXXXXXX
POST restoreXXXXXXXXXXXX
POST restore_fileXXX
POST restore_filesXXX
POST set_retentionXXXXXXXXX

certificates

The REST API supports the following features and functions for the certificates object type:

Operation11.11.21.31.41.51.61.71.81.91.101.11
GETXX
Additional returned properties:
hashXX
certificateXX
subjectXX
issuerXX
serialnoXX
DELETEXX
POSTXX

datastore

The REST API supports the following features and functions for the datastore object type:

Operation11.11.21.31.41.51.61.71.81.91.101.11
GETXXXXXXXXXXXX
Additional returned properties:
compute_cluster_parent_hypervisor_object_idXXXXXXXX
compute_cluster_parent_nameXXXXXXXX
hypervisor_management_systemXXXXXXXX
hypervisor_management_system_nameXXXX
hypervisor_object_idXXXXXXXXXXXX
hypervisor_typeXXXXXXX
DELETEXXXXXXXXXXXX
GET standard_hostsXXXX
POSTXXXXXXXXXXXX
POST resizeXXXXXXXXXXX
POST set_policyXXXXXXXXXX
POST shareXXXX
Post unshareXXXX

host

The REST API supports the following features and functions for the host object type:

Operation11.11.21.31.41.51.61.71.81.91.101.11
GETXXXXXXXXXXXX
Additional returned properties:
can_rollbackXXXXXXXX
compute_cluster_hypervisor_object_idXXXXXXXXXX
compute_cluster_nameXXXXXXXXXX
compute_cluster_parent_hypervisor_object_idXXXXXXXX
compute_cluster_parent_nameXXXXXXXX
current_feature_levelXXXXXXXX
dateXXXXXXXXXX
federation_ipXXXXXXXXX
federation_maskXXXXXX
federation_mtuXXXXXX
hypervisor_management_systemXXXX
hypervisor_management_system_nameXXXX
infosight_configurationX
life_remainingXXXXXXXXX
management_maskXXXXXX
management_mtuXXXXXX
omnistack_cluster_idXXX
policy_enabledXXXXXXXX
potential_feature_levelXXXXXXXX
storage_ipXXXXXXXXX
storage_maskXXXXXX
storage_maskXXXXXX
upgrade_stateXXXXXXXX
virtual_controller_nameXXXXXXXXX
GET capacityXXXXXXXXXX
GET hardwareXXXXXXXXXXX
GET metricsXXXXXXXXXX
GET virtual_controller_shutdown_statusXXX
POST cancel_virtual_controller_shutdownXXX
POST remove_from_federationXXX
POST shutdown_virtual_controllerXXX

omnistack_cluster

The REST API supports the following features and functions for the omnistack_cluster object type:

Operation11.11.21.31.41.51.61.71.81.91.101.11
GETXXXXXXXXXXXX
Additional returned properties:
arbiter_addressXXXXXXXXXXX
arbiter_connectedXXXXXXXXXXX
connected_clusterXXX
hypervisor_management_systemXXXXXX
hypervisor_management_system_nameXXXX
hypervisor_object_idXXXXXXXXXX
hypervisor_object_parent_idXXXXXXXXX
hypervisor_object_parent_nameXXXXXXXXX
hypervisor_typeXXXXXXX
infosight_configurationX
time_zoneXXXXXXXXXX
upgrade_stateXXXXXXXXX
upgrade_task_idXXXXXXXXX
versionXXXXXXXX
GET connected_clustersXXXXXXXXX
GET metricsXXXXXXXXXXX
GET throughputXXXXXXXXX
GET time_zone_listXXXXXXXXX
POST set_time_zoneXXXXXXXXX

policy

The REST API supports the following features and functions for the policy object type:

Operation11.11.21.31.41.51.61.71.81.91.101.11
GETXXXXXXXXXXXX
GET datastoresXXXXXXXXX
GET virtual_machinesXXXXXXXXX
DELETEXXXXXXXXXXXX
POST policiesXXXXXXXXXXXX
POST renameXXXXXXXXXXX
POST resumeXXXXXXXX
POST rulesX (one rule)X (multiple rules)XXXXXXXXXX
POST suspendXXXXXXXX
POST impact_report/create_rulesXXX
POST impact_report/edit_rulesXXX
POST impact_report/delete_ruleXXX
PUT ruleXXXXXXXXXXXX

task

The REST API supports the following features and functions for the task object type:

Operation11.11.21.31.41.51.61.71.81.91.101.11
GETXXXXXXXXXXXX

virtual_machine

The REST API supports the following features and functions for the virtual_machine object type:

Operation11.11.21.31.41.51.61.71.81.91.101.11
GETXXXXXXXXXXXX
Additional returned properties:
adapter_type
app_aware_vm_statusXXXXXXXXX
compute_cluster_parent_hypervisor_object_idXXXXXXXX
compute_cluster_parent_nameXXXXXXXX
device_numberXXXXXXX
network_interfacesXXXX
network_labelXXXX
ha_resynchronization_progressXXXXXXXXXXX
host_idXXXXXXXXXXX
hypervisor_allocated_capacityXXXXXXXX
hypervisor_allocated_cpuXXXX
hypervisor_consumed_cpuXXXX
hypervisor_consumed_memoryXXXX
hypervisor_cpu_countXXXXXXXX
hypervisor_free_spaceXXXXXXXX
hypervisor_folder_nameXXXX
hypervisor_is_templateXXXXXXXX
hypervisor_management_systemXXXXX
hypervisor_management_system_nameXXXX
hypervisor_total_memoryXXXXXXXX
hypervisor_typeXXXXXXX
hypervisor_virtual_disk_countXXXXXXXX
hypervisor_virtual_machine_power_stateXXXXXXXXXX
modified_atXXXX
ipv4_addressesXXXX
mac_addressXXXX
mac_generationXXXX
network_interfacesXXXX
replica_setXXXXXXXXXXX
GET backupsXXXXXXXXX
GET metricsXXXXXXXXXXX
POST backupXXXXXXXXXXXX
POST backup_parametersXXXX
POST cloneXXXXXXXXXXXX
POST moveXXXXXXXXXXXX
POST set_policyXXXXXXXXXXXX
POST validate_backup_credentialsXXXX
POST policy_impact_report/apply_policyXXX

Blog feed