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:

  • backups
  • cluster_groups
  • datastores
  • external_stores
  • hosts
  • omnistack_clusters
  • policies
  • security/certificates
  • tasks
  • virtual_machines

backups

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

Operation1.151.141.131.121.111.101.91.81.71.61.51.41.31.21.11
GETXXXXXXXXXXXXXXXX
Additional returned properties:
   external_store_nameXX
   compute_cluster_parent_hypervisor_object_idXXXXXXXXXXX
   compute_cluster_parent_nameXXXXXXXXXXX
   consistency_typeXXXXXXXXXXXX
   hypervisor_typeXXXXXXXXXX
   sent_completion_timeXXXXXXX
   sent_durationXXXXXXX
   unique_size_bytesXXXXXXXXXXX
   unique_size_timestampXXXXXXXXXXX
   virtual_machine_stateXXXXXXXXXXXXX
    virtual_machine_typeXXXXXXXXXXX
GET virtual_disksXXXXXX
GET virtual_disk_partitionsXXXXXX
GET virtual_disk_partition_filesXXXXXX
DELETEXXXXXXXXXXXXXXX
POST calculate_unique_sizeXXXXXXX
POST cancelXXXXXXX
POST copyXXXXXXXXXXXXX
POST deleteXXXXXXXXXX
POST lockXXXXXXXXXXXXX
POST renameXXXXXXXXXXXXXXXX
POST restoreXXXXXXXXXXXXXXXX
POST restore_fileXXXXXX
POST restore_filesXXXXXX
POST set_retentionXXXXXXXXXXXX

cluster_groups

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

Operation1.151.141.131.121.111.101.91.81.71.61.51.41.31.21.11
GETXXXXX
POST renameXXXXX

datastores

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

Operation1.151.141.131.121.111.101.91.81.71.61.51.41.31.21.11
GETXXXXXXXXXXXXXXXX
Additional returned properties:
   compute_cluster_parent_hypervisor_object_idXXXXXXXXXXX
   compute_cluster_parent_nameXXXXXXXXXXX
   hypervisor_management_systemXXXXXXXXX
   hypervisor_management_system_nameXXXXXXX
   hypervisor_object_idXXXXXXXXXXXXXX
   hypervisor_typeXXXXXXXXXX
DELETEXXXXXXXXXXXXXXX
GET standard_hostsXXXXXXX
POSTXXXXXXXXXXXXXXXX
POST resizeXXXXXXXXXXXXXX
POST set_policyXXXXXXXXXXXXX
POST shareXXXXXXX
Post unshareXXXXXXX

external_stores

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

Operation1.151.141.131.121.111.101.91.81.71.61.51.41.31.21.11
GETXX
Additional returned properties:
   nameXX
   omnistack_cluster_idXX
   management_ipXX
   management_portXX
   storage_portXX
   ipXX
POSTXX
POST update_credentialsX
POST unregisterX

hosts

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

Operation1.151.141.131.121.111.101.91.81.71.61.51.41.31.21.11
GETXXXXXXXXXXXXXXXX
Additional returned properties:
   availability_zone_effectiveX
   availability_zone_plannedX
   can_rollbackXXXXXXXXXXX
   compute_cluster_hypervisor_object_idXXXXXXXXXXXXX
   compute_cluster_nameXXXXXXXXXXXXX
   compute_cluster_parent_hypervisor_object_idXXXXXXXXXXX
   compute_cluster_parent_nameXXXXXXXXXXX
   current_feature_levelXXXXXXXXXXX
   dateXXXXXXXXXXXXX
   federation_ipXXXXXXXXXXXX
   federation_maskXXXXXXXXX
   federation_mtuXXXXXXXXX
   hypervisor_management_systemXXXXXXX
   hypervisor_management_system_nameXXXXXXXX
   infosight_configurationXXXX
   life_remainingXXXXXXXXXXXX
   management_maskXXXXXXXXX
   management_mtuXXXXXXXXX
   omnistack_cluster_idXXXXXX
   policy_enabledXXXXXXXXXXX
   potential_feature_levelXXXXXXXXXXX
   storage_ipXXXXXXXXXXXX
   storage_maskXXXXXXXXX
   storage_mtuXXXXXXXXX
   upgrade_stateXXXXXXXXXXX
   virtual_controller_nameXXXXXXXXXXXX
GET capacityXXXXXXXXXXXXX
GET hardwareXXXXXXXXXXXXXX
GET metricsXXXXXXXXXXXXX
GET virtual_controller_shutdown_statusXXXXXX
POST cancel_virtual_controller_shutdownXXXXXX
POST remove_from_federationXXXXXX
POST shutdown_virtual_controllerXXXXXX

omnistack_clusters

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

Operation1.151.141.131.121.111.101.91.81.71.61.51.41.31.21.11
GETXXXXXXXXXXXXXXXX
Additional returned properties:
   arbiter_addressXXXXXXXXXXXXXX
   arbiter_configuredX
   arbiter_connectedXXXXXXXXXXXXXX
   arbiter_requiredXX
   cluster_feature_levelXXX
   connected_clusterXXXXXX
   hypervisor_management_systemXXXXXXXXX
   hypervisor_management_system_nameXXXXXXX
   hypervisor_object_idXXXXXXXXXXXXX
   hypervisor_object_parent_idXXXXXXXXXXXX
   hypervisor_object_parent_nameXXXXXXXXXXXX
   hypervisor_typeXXXXXXXXXX
   infosight_configurationXXXX
   time_zoneXXXXXXXXXXXXX
   upgrade_stateXXXXXXXXXXXX
   upgrade_task_idXXXXXXXXXXXX
   versionXXXXXXXXXXX
GET connected_clustersXXXXXXXXXXXX
GET metricsXXXXXXXXXXXXXX
GET throughputXXXXXXXXXXXX
GET time_zone_listXXXXXXXXXXXX
POST set_time_zoneXXXXXXXXXXXXX

policies

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

Operation1.151.141.131.121.111.101.91.81.71.61.51.41.31.21.11
GETXXXXXXXXXXXXXXXX
GET datastoresXXXXXXXXXXXXXXXX
GET /policies/policy_schedule_reportXXXX
GET virtual_machinesXXXXXXXXXXXXXXXX
DELETEXXXXXXXXXXXXXXXX
POST policiesXXXXXXXXXXXXXXXX
POST renameXXXXXXXXXXXXXX
POST resumeXXXXXXXXXXX
POST rulesXXXXXXXXXXXXXXX (multiple rules)X (one rule)
POST suspendXXXXXXXXXXX
POST impact_report/create_rulesXXXXXX
POST impact_report/edit_rulesXXXXXX
POST impact_report/delete_ruleXXXXXX
PUT ruleXXXXXXXXXXXXXXX

security/certificates

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

Operation1.151.141.131.121.111.101.91.81.71.61.51.41.31.21.11
GETXXXXX
Additional returned properties:
   hashXXXXX
   certificateXXXXX
   subjectXXXXX
   issuerXXXXX
   serialnoXXXXX
DELETEXXXXX
POSTXXXXX

tasks

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

Operation1.151.141.131.121.111.101.91.81.71.61.51.41.31.21.11
GETXXXXXXXXXXXXXXXX

virtual_machines

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

Operation1.151.141.131.121.111.101.91.81.71.61.51.41.31.21.11
GETXXXXXXXXXXXXXXXX
Additional returned properties:
   adapter_typeXXXXXX
   app_aware_vm_statusXXXXXXXXXXXX
   compute_cluster_parent_hypervisor_object_idXXXXXXXXXXX
   compute_cluster_parent_nameXXXXXXXXXXX
   deleted_atXXXXXXXXXX
   device_numberXXXXXXXXXX
   network_interfacesXXXXXXX
   network_labelXXXXXXX
   ha_resynchronization_progressXXXXXXXXXXXXXX
   host_idXXXXXXXXXXXXXX
   hypervisor_allocated_capacityXXXXXXXXXXX
   hypervisor_allocated_cpuXXXXXXX
   hypervisor_consumed_cpuXXXXXXX
   hypervisor_consumed_memoryXXXXXXX
   hypervisor_cpu_countXXXXXXXXXXX
   hypervisor_free_spaceXXXXXXXXXXX
   hypervisor_folder_nameXXXXXXX
   hypervisor_is_templateXXXXXXXXXXX
   hypervisor_management_systemXXXXXXXX
   hypervisor_management_system_nameX XXXXXX
   hypervisor_total_memoryXXXXXXXXXXX
   hypervisor_typeXXXXXXXXXX
   hypervisor_virtual_disk_countXXXXXXXXXXX
   hypervisor_virtual_machine_power_stateXXXXXXXXXXXXX
   modified_atXXXXXXX
   ipv4_addressesXXXXXXX
   mac_addressXXXXXXX
   mac_generationXXXXXXX
   network_interfacesXXXXXXX
   replica_setXXXXXXXXXXXXXX
GET backupsXXXXXXXXXXXXXXXX
GET metricsXXXXXXXXXXXXXX
POST backupXXXXXXXXXXXXXXXX
POST backup_parametersXXXXXXX
POST cloneXXXXXXXXXXXXXXXX
POST moveXXXXXXXXXXXXXXXX
POST set_policyXXXXXXXXXXXXXXXX
POST validate_backup_credentialsXXXXXXX
POST policy_impact_report/apply_policyXXXXXX
POST power_offXXXX

Blog feed