# SimpliVity omnistack_clusters API

**Canonical:** https://apis.io/apis/simplivity/simplivity-omnistack-clusters-api/  
**Provider:** SimpliVity — https://apis.io/providers/simplivity/  
**Base URL:** https://management-virtual-appliance/api  
**Documentation:** https://github.com/HewlettPackard/hpe-simplivity-swagger

SimpliVity omnistack_clusters API is one of 10 APIs that [SimpliVity](https://apis.io/providers/simplivity/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. The published artifact set on APIs.io includes an OpenAPI specification and authentication docs.

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.

## Operations (8)

| Method | Path | Summary |
|---|---|---|
| GET | `/omnistack_clusters` | Retrieves all defined omnistack_clusters on the system |
| GET | `/omnistack_clusters/time_zone_list` | Retrieves a list of all valid time zones |
| GET | `/omnistack_clusters/{clusterId}` | Retrieves the specified omnistack_cluster |
| GET | `/omnistack_clusters/{clusterId}/connected_clusters` | Retrieves directly connected omnistack_clusters |
| GET | `/omnistack_clusters/{clusterId}/metrics` | Retrieves throughput, IOPS, and latency data for the cluster |
| POST | `/omnistack_clusters/{clusterId}/set_iwo` | Sets the IWO status of the omnistack_cluster |
| POST | `/omnistack_clusters/{clusterId}/set_time_zone` | Sets the time zone of the omnistack_cluster |
| GET | `/omnistack_clusters/{clusterId}/throughput` | Calculates the throughput between each pair of omnistack_clusters in the federation |

## Machine-readable artifacts (3)

- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/simplivity/refs/heads/main/openapi/simplivity-omnistack-clusters-api-openapi.yml
- **Authentication** — https://raw.githubusercontent.com/api-evangelist/simplivity/refs/heads/main/authentication/simplivity-authentication.yml
- **OAuthScopes** — https://raw.githubusercontent.com/api-evangelist/simplivity/refs/heads/main/scopes/simplivity-scopes.yml

## Other SimpliVity APIs (9)

- [SimpliVity backups API](https://apis.io/apis/simplivity/simplivity-backups-api/)
- [SimpliVity cluster_groups API](https://apis.io/apis/simplivity/simplivity-cluster-groups-api/)
- [SimpliVity datastores API](https://apis.io/apis/simplivity/simplivity-datastores-api/)
- [SimpliVity external_stores API](https://apis.io/apis/simplivity/simplivity-external-stores-api/)
- [SimpliVity hosts API](https://apis.io/apis/simplivity/simplivity-hosts-api/)
- [SimpliVity policies API](https://apis.io/apis/simplivity/simplivity-policies-api/)
- [SimpliVity security API](https://apis.io/apis/simplivity/simplivity-security-api/)
- [SimpliVity tasks API](https://apis.io/apis/simplivity/simplivity-tasks-api/)
- [SimpliVity virtual_machines API](https://apis.io/apis/simplivity/simplivity-virtual-machines-api/)

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/simplivity/simplivity-omnistack-clusters-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/simplivity/.