Overview
Cisco HyperFlex HX-Series Systems provide a fully-contained, virtual server platform that combines all three layers of compute, storage, and network with the powerful Cisco HX Data Platform software tool resulting in a single point of connectivity for simplified management. Cisco HyperFlex Systems are modular systems designed to scale out by adding HX nodes under a single UCS management domain. The hyperconverged system provides a unified pool of resources based on your workload needs.
Cisco HyperFlex Systems RESTful APIs with HTTP verbs integrate with other third-party management and monitoring tools that can be configured to make HTTP calls. It enables authentication, replication, encryption, monitoring, and management of a HyperFlex system through an on-demand stateless protocol. The APIs allow for external applications to interface directly with the Hyperflex management plane.
For additional information on Cisco HyperFlex Systems, its configuration and more, refer to the Cisco HyperFlex Systems Documentation at: https://www.cisco.com/c/en/us/support/hyperconverged-systems/hyperflex-hx-data-platform-software/tsd-products-support-series-home.html.
Important:
These HyperFlex REST APIs are subject to change and deprecation in future releases. Please use the REST explorer [Try it out!] option to execute the operation and determine the response type based on the response.
Note:
Plans to deprecate legacy REST APIs (api family with the prefix /rest) were made in HX 3.5(x), and users encouraged to use the similar APIs in coreapi (api family which has the prefix /coreapi). As of HX 4.5 and later, legacy rest APIs are deprecated and are no longer supported. If you are still using REST APIs that begin with /rest, please make sure to use REST APIs in coreapi (REST APIs which begin with /coreapi) instead: https://testing-developer.cisco.com/pubhub/docs/400/new/#!core-functionalities
See below for a list of deprecated legacy APIs and how they map to coreapi:
Map of Deprecated Legacy APIs to new coreapi
The following is a list of legacy APIs that were deprecated and how they map to new coreapi.
| Legacy API | Mapped To |
|---|---|
| GET /rest/about | GET /coreapi/v1/clusters/{cuuid}/about |
| GET /rest/cluster/savings | GET /coreapi/v1/clusters/{cuuid} |
| GET /rest/cluster/time | GET /coreapi/v1/clusters/{cuuid}/services/timezone |
| POST /rest/clusterVersionDetails | GET /coreapi/v1/clusters/{cuuid}/about, GET /coreapi/v1/hypervisor/controllervms, GET /coreapi/v1/hypervisor/hosts |
| GET /rest/clusters | GET /coreapi/v1/clusters |
| GET /rest/usercontext | JWT Token |
| GET /rest/virtplatform/cluster | GET /coreapi/v1/clusters/ |
| POST /rest/cluster/shutdown | POST /coreapi/v1/clusters/{cuuid} |
| POST /rest/cluster/start | POST /coreapi/v1/clusters/{cuuid} |
| POST /rest/cluster/set-zone | PUT /coreapi/v1/clusters/{cuuid}/services/timezone |
| POST /rest/maintenancemode/{action} | POST /coreapi/v1/clusters/{cuuid}/nodes/{nuuid}/entermaintenancemode, POST /coreapi/v1/clusters/{cuuid}/nodes/{nuuid}/exitmaintenancemode |
| GET /rest/job | GET /coreapi/v1/clusters/{cuuid}/tasks, GET /coreapi/v1/clusters/jobs |
| GET /rest/datastores | GET /coreapi/v1/clusters/{cuuid}/datastores |
| POST /rest/datastores | POST /coreapi/v1/clusters/{cuuid}/datastores |
| DELETE /rest/datastores/{datastoreId} | DELETE /coreapi/v1/clusters/{cuuid}/datastores/{dsuuid} |
| GET /rest/datastores/{datastoreId} | GET /coreapi/v1/clusters/{cuuid}/datastores/{dsuuid} |
| POST /rest/datastores/{datastoreId} | POST /coreapi/v1/clusters/{cuuid}/datastores/{dsuuid} |
| POST /rest/physicaldisks | GET /coreapi/v1/hypervisor/disks |
| DELETE /rest/network/smtp | DELETE /coreapi/v1/clusters/{cuuid}/services/smtp |
| GET /rest/network/smtp | GET /coreapi/v1/clusters/{cuuid}/services/smtp |
| POST /rest/network/smtp | POST /coreapi/v1/clusters/{cuuid}/services/smtp |
| GET /rest/network/{serverType} | GET /coreapi/v1/clusters/{cuuid}/services/dns, GET coreapi/v1/clusters/{cuuid}/services/ntp |
| POST /rest/network/{serverType}/{operationType} | /coreapi/v1/clusters/{cuuid}/services/dns, coreapi/v1/clusters/{cuuid}/services/ntp DELETE, POST |
| GET /rest/networkconfig | various |
| GET /rest/virtplatform/networks | GET /coreapi/v1/clusters/{cuuid}/network |
| GET /rest/appliances | GET /coreapi/v1/hypervisor/* |
| GET /rest/virtplatform/alarms | GET /coreapi/v1/clusters/{cuuid}/alarms |
| POST /rest/virtplatform/alarms/acknowledge | PUT /coreapi/v1/clusters/{cuuid}/alarms/{auuid} |
| POST /rest/virtplatform/alarms/reset | DELETE /coreapi/v1/clusters/{cuuid}/alarms/{auuid} |
| GET /rest/virtplatform/events | GET /coreapi/v1/clusters/{cuuid}/events |
| GET /stats | TBD |
| POST /rest/clone/{vmId} | /coreapi/v1/hypervisor/vms/{vmid}/clone |
| POST /rest/snapshots/{entityId} | POST /vaai/vms/{vmId}/snapshots (async with hxtask) |
| GET /rest/virtplatform/snapshots/{vmId} | Used by HX Connect only |
| GET /rest/virtplatform/vmfolders | Used by HX Connect only |
| GET /rest/virtplatform/vmfolders/{folderId} | NA |
| GET /rest/virtplatform/resourcepools | Used by HX Connect only |
| GET /rest/virtplatform/resourcepools/{resourcePoolId} | NA |
| GET /rest/virtplatform/vms | GET /coreapi/v1/hypervisor/vms |
| GET /rest/virtplatform/vms/{vmId} | GET /coreapi/v1/hypervisor/vms/{vmid} |
| POST /rest/virtplatform/vms/{vmId} | POST /coreapi/v1/hypervisor/vms/{vmid} |
| /rest/security/whitelist | NA |
| /rest/security/whitelist?action=add | NA |
| GET /rest/vcenter | NA |