How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

SimpliVity omnistack_clusters API

An omnistack_cluster is a logical grouping of systems that run the HPE OmniStack software. The user defines an omnistack_cluster to efficiently share resources across the systems.

SimpliVity omnistack_clusters API is one of 10 APIs that SimpliVity publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

The published artifact set on APIs.io includes an OpenAPI specification and authentication docs.

This API exposes 8 operations across 8 paths, and defines 12 schemas. It is described by OpenAPI 3.2.0, at version 1.25.

Requests are made against a single base URL, https://localhost.

8 operations 8 paths 12 schemas 6 GET2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.25
Base URL
https://management-virtual-appliance/api
Authentication
OAuth 2.0
Contact
Hewlett Packard Enterprise
License
HPE OmniStack REST API
Resource Areas
1

Authentication & Security 1

SimpliVity omnistack_clusters API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (OAuth2) using the password flow, exposing 2 scopes.

Paths & Operations 8

Across 8 paths, the API surfaces 8 operations — 6 GET, 2 POST. Each is listed below with its method, path, parameters, and response codes.

omnistack_clusters 8

An omnistackcluster is a logical grouping of systems that run the HPE OmniStack software. The user defines an omnistackcluster to efficiently share resources across the systems.

GET
/omnistack_clusters
Retrieves all defined omnistackclusters on the system
listClusters 19 params → 200401403404
GET
/omnistack_clusters/time_zone_list
Retrieves a list of all valid time zones
getTimeZones → 200401403404
GET
/omnistack_clusters/{clusterId}
Retrieves the specified omnistackcluster
getCluster 1 param → 200401403404
GET
/omnistack_clusters/{clusterId}/connected_clusters
Retrieves directly connected omnistackclusters
getConnectedClusters 1 param → 200401403404
GET
/omnistack_clusters/{clusterId}/metrics
Retrieves throughput, IOPS, and latency data for the cluster
getClusterPerfomance 4 params → 200401403404
POST
/omnistack_clusters/{clusterId}/set_iwo
Sets the IWO status of the omnistackcluster
enableClusterIWO 1 param body → 200201401403404
POST
/omnistack_clusters/{clusterId}/set_time_zone
Sets the time zone of the omnistackcluster
setClusterTimeZone 1 param body → 200201401403404
GET
/omnistack_clusters/{clusterId}/throughput
Calculates the throughput between each pair of omnistackclusters in the federation
getClustersThroughput 4 params → 200401403404

Schemas 12

The contract defines 12 schemas that model the data the API accepts and returns. The most detailed are omnistack_cluster (36 properties), omnistack_cluster_throughput (11 properties), TaskMO (7 properties), infosight_configuration (5 properties). Each schema is shown below with its type and property counts.

omnistack_cluster_to_cluster_throughput
object
Calculated throughput between source and destination omnistackclusters
3 properties 3 required
infosight_configuration
object
The current configuration of the HPE InfoSight service
5 properties
analytics_info
object
The metrics information
2 properties 2 required
cluster_throughput_data
object
The metrics information
5 properties 5 required
MetricsRawDataMO
object
2 properties 2 required
AffectedObjectMO
object
2 properties 2 required
MetricsDataMO
object
3 properties 3 required
set_time_zone
object
Sets the time zone of the omnistackcluster
1 property 1 required
omnistack_cluster
object
An omnistackcluster defined on this system
36 properties 32 required
omnistack_cluster_throughput
object
Calculated throughput between source and destination omnistackclusters
11 properties 11 required
TaskMO
object
A task that was created as a result of an operation performed on the system
7 properties 5 required
enabled
object
An indicator to show the status of IWO for the omnistackcluster Valid values: True: IWO is enabled for the omnistackcluster. False: IWO is disabled for the omn…
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

simplivity-omnistack-clusters-api-openapi.yml Raw ↑

Other APIs SimpliVity publishes across the network.

SimpliVity backups API
SimpliVity cluster_groups API
SimpliVity datastores API
SimpliVity external_stores API
SimpliVity hosts API
SimpliVity policies API
SimpliVity security API
SimpliVity tasks API
SimpliVity virtual_machines API
Where this information came from

This is an independent, third-party profile of SimpliVity omnistack_clusters API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.