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.141.131.121.111.101.91.81.71.61.51.41.31.21.11
GETXXXXXXXXXXXXXXX
Additional returned properties:
   external_store_nameX
   compute_cluster_parent_hypervisor_object_idXXXXXXXXXX
   compute_cluster_parent_nameXXXXXXXXXX
   consistency_typeXXXXXXXXXXX
   hypervisor_typeXXXXXXXXX
   sent_completion_timeXXXXXX
   sent_durationXXXXXX
   unique_size_bytesXXXXXXXXXX
   unique_size_timestampXXXXXXXXXX
   virtual_machine_stateXXXXXXXXXXXX
    virtual_machine_typeXXXXXXXXXX
GET virtual_disksXXXXX
GET virtual_disk_partitionsXXXXX
GET virtual_disk_partition_filesXXXXX
DELETEXXXXXXXXXXXXXXX
POST calculate_unique_sizeXXXXXXX
POST cancelXXXXXXX
POST copyXXXXXXXXXXXXX
POST deleteXXXXXXXXXX
POST lockXXXXXXXXXXXXX
POST renameXXXXXXXXXXXXXXX
POST restoreXXXXXXXXXXXXXXX
POST restore_fileXXXXX
POST restore_filesXXXXX
POST set_retentionXXXXXXXXXXX

cluster_groups

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

Operation1.141.131.121.111.101.91.81.71.61.51.41.31.21.11
GETXXXX
POST renameXXXX

datastores

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

Operation1.141.131.121.111.101.91.81.71.61.51.41.31.21.11
GETXXXXXXXXXXXXXXX
Additional returned properties:
   compute_cluster_parent_hypervisor_object_idXXXXXXXXXX
   compute_cluster_parent_nameXXXXXXXXXX
   hypervisor_management_systemXXXXXXXX
   hypervisor_management_system_nameXXXXXX
   hypervisor_object_idXXXXXXXXXXXXX
   hypervisor_typeXXXXXXXXX
DELETEXXXXXXXXXXXXXX
GET standard_hostsXXXXXX
POSTXXXXXXXXXXXXXXX
POST resizeXXXXXXXXXXXXX
POST set_policyXXXXXXXXXXXX
POST shareXXXXXX
Post unshareXXXXXX

external_stores

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

Operation1.141.131.121.111.101.91.81.71.61.51.41.31.21.11
GETX
Additional returned properties:
   nameX
   omnistack_cluster_idX
   management_ipX
   management_portX
   storage_portX
   ipX
POSTX

hosts

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

Operation1.141.131.121.111.101.91.81.71.61.51.41.31.21.11
GETXXXXXXXXXXXXXXX
Additional returned properties:
   can_rollbackXXXXXXXXXX
   compute_cluster_hypervisor_object_idXXXXXXXXXXXX
   compute_cluster_nameXXXXXXXXXXXX
   compute_cluster_parent_hypervisor_object_idXXXXXXXXXX
   compute_cluster_parent_nameXXXXXXXXXX
   current_feature_levelXXXXXXXXXX
   dateXXXXXXXXXXXX
   federation_ipXXXXXXXXXXX
   federation_maskXXXXXXXX
   federation_mtuXXXXXXXX
   hypervisor_management_systemXXXXXXX
   hypervisor_management_system_nameXXXXXX
   infosight_configurationXXX
   life_remainingXXXXXXXXXXX
   management_maskXXXXXXXX
   management_mtuXXXXXXXX
   omnistack_cluster_idXXXXX
   policy_enabledXXXXXXXXXX
   potential_feature_levelXXXXXXXXXX
   storage_ipXXXXXXXXXXX
   storage_maskXXXXXXXX
   storage_mtuXXXXXXXX
   upgrade_stateXXXXXXXXXX
   virtual_controller_nameXXXXXXXXXXX
GET capacityXXXXXXXXXXXX
GET hardwareXXXXXXXXXXXXX
GET metricsXXXXXXXXXXXX
GET virtual_controller_shutdown_statusXXXXX
POST cancel_virtual_controller_shutdownXXXXX
POST remove_from_federationXXXXX
POST shutdown_virtual_controllerXXXXX

omnistack_clusters

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

Operation1.141.131.121.111.101.91.81.71.61.51.41.31.21.11
GETXXXXXXXXXXXXXXX
Additional returned properties:
   arbiter_addressXXXXXXXXXXXXX
   arbiter_configuredX
   arbiter_connectedXXXXXXXXXXXXX
   arbiter_requiredX
   cluster_feature_levelXX
   connected_clusterXXXXX
   hypervisor_management_systemXXXXXXXX
   hypervisor_management_system_nameXXXXXX
   hypervisor_object_idXXXXXXXXXXXX
   hypervisor_object_parent_idXXXXXXXXXXX
   hypervisor_object_parent_nameXXXXXXXXXXX
   hypervisor_typeXXXXXXXXX
   infosight_configurationXXX
   time_zoneXXXXXXXXXXXX
   upgrade_stateXXXXXXXXXXX
   upgrade_task_idXXXXXXXXXXX
   versionXXXXXXXXXX
GET connected_clustersXXXXXXXXXXX
GET metricsXXXXXXXXXXXXX
GET throughputXXXXXXXXXXX
GET time_zone_listXXXXXXXXXXX
POST set_time_zoneXXXXXXXXXXXX

policies

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

Operation1.141.131.121.111.101.91.81.71.61.51.41.31.21.11
GETXXXXXXXXXXXXXXX
GET datastoresXXXXXXXXXXXXXXX
GET /policies/policy_schedule_reportXXX
GET virtual_machinesXXXXXXXXXXXXXXX
DELETEXXXXXXXXXXXXXXX
POST policiesXXXXXXXXXXXXXXX
POST renameXXXXXXXXXXXXX
POST resumeXXXXXXXXXX
POST rulesXXXXXXXXXXXXXX (multiple rules)X (one rule)
POST suspendXXXXXXXXXX
POST impact_report/create_rulesXXXXX
POST impact_report/edit_rulesXXXXX
POST impact_report/delete_ruleXXXXX
PUT ruleXXXXXXXXXXXXXX

security/certificates

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

Operation1.141.131.121.111.101.91.81.71.61.51.41.31.21.11
GETXXXX
Additional returned properties:
   hashXXXX
   certificateXXXX
   subjectXXXX
   issuerXXXX
   serialnoXXXX
DELETEXXXX
POSTXXXX

tasks

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

Operation1.141.131.121.111.101.91.81.71.61.51.41.31.21.11
GETXXXXXXXXXXXXXXX

virtual_machines

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

Operation1.141.131.121.111.101.91.81.71.61.51.41.31.21.11
GETXXXXXXXXXXXXXXX
Additional returned properties:
   adapter_typeXXXXXX
   app_aware_vm_statusXXXXXXXXXXX
   compute_cluster_parent_hypervisor_object_idXXXXXXXXXX
   compute_cluster_parent_nameXXXXXXXXXX
   deleted_atXXXXXXXXX
   device_numberXXXXXXXXX
   network_interfacesXXXXXX
   network_labelXXXXXX
   ha_resynchronization_progressXXXXXXXXXXXXX
   host_idXXXXXXXXXXXXX
   hypervisor_allocated_capacityXXXXXXXXXX
   hypervisor_allocated_cpuXXXXXX
   hypervisor_consumed_cpuXXXXXX
   hypervisor_consumed_memoryXXXXXX
   hypervisor_cpu_countXXXXXXXXXX
   hypervisor_free_spaceXXXXXXXXXX
   hypervisor_folder_nameXXXXXX
   hypervisor_is_templateXXXXXXXXXX
   hypervisor_management_systemXXXXXXX
   hypervisor_management_system_nameXXXXXX
   hypervisor_total_memoryXXXXXXXXXX
   hypervisor_typeXXXXXXXXX
   hypervisor_virtual_disk_countXXXXXXXXXX
   hypervisor_virtual_machine_power_stateXXXXXXXXXXXX
   modified_atXXXXXX
   ipv4_addressesXXXXXX
   mac_addressXXXXXX
   mac_generationXXXXXX
   network_interfacesXXXXXX
   replica_setXXXXXXXXXXXXX
GET backupsXXXXXXXXXXXXXXX
GET metricsXXXXXXXXXXXXX
POST backupXXXXXXXXXXXXXXX
POST backup_parametersXXXXXX
POST cloneXXXXXXXXXXXXXXX
POST moveXXXXXXXXXXXXXXX
POST set_policyXXXXXXXXXXXXXXX
POST validate_backup_credentialsXXXXXX
POST policy_impact_report/apply_policyXXXXX
POST power_offXXX

Blog feed