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 hosts API

A host is a virtual object that uses HPE OmniStack software in a federation.

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

Tagged areas include Hosts. The published artifact set on APIs.io includes an OpenAPI specification and authentication docs.

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

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

9 operations 9 paths 18 schemas 6 GET3 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 hosts API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (OAuth2) using the password flow, exposing 2 scopes.

Paths & Operations 9

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

hosts 9

A host is a virtual object that uses HPE OmniStack software in a federation.

GET
/hosts
Retrieves all hosts defined on this system
listHosts 37 params → 200401403404
GET
/hosts/{hostId}
Retrieves the specified host
getHost 1 param → 200401403404
POST
/hosts/{hostId}/cancel_virtual_controller_shutdown
Cancels the shutdown of the Virtual Controller
cancelShutdownVirtualControllerUsingPOST 1 param → 200201401403404
GET
/hosts/{hostId}/capacity
Host Capacity
getHostCapacity 5 params → 200401403404
GET
/hosts/{hostId}/hardware
Retrieves hardware information for the host
getHostHardware 1 param → 200401403404
GET
/hosts/{hostId}/metrics
Retrieves throughput, IOPS, and latency data for the host
getHostMetrics 4 params → 200401403404
POST
/hosts/{hostId}/remove_from_federation
Removes the specified host from the federation. The specified hostId must not be the host executing the request.
removeHostFromFederation 1 param body → 200201202401403404
POST
/hosts/{hostId}/shutdown_virtual_controller
Shuts down the Virtual Controller safely (by reaching HA compliance) or by force
shutdownVirtualControllerUsingPOST 1 param body → 200201401403404
GET
/hosts/{hostId}/virtual_controller_shutdown_status
Retrieves the shutdown status of the Virtual Controller
getVirtualControllerShutdownStatusUsingGET 1 param → 200401403404

Schemas 18

The contract defines 18 schemas that model the data the API accepts and returns. The most detailed are host (47 properties), physical_drive (15 properties), host_hardware (11 properties), logical_drive (10 properties). Each schema is shown below with its type and property counts.

ShutdownVirtualControllerMO
object
1 property
analytics_info
object
The metrics information
2 properties 2 required
ShutdownStatusMO
object
1 property 1 required
capacity_info
object
The metrics information
2 properties 2 required
MetricsRawDataMO
object
2 properties 2 required
host_hardware
object
A list of hardware modules for the host
11 properties 10 required
logical_drive
object
A host that is defined on this system
10 properties 10 required
AffectedObjectMO
object
2 properties 2 required
host
object
A host that is defined on this system
47 properties 33 required
MetricsDataMO
object
3 properties 3 required
remove_from_federation
object
Removes the specified host from the federation. The specified hostId must not be the host executing the request.
1 property
battery
object
The backup battery unit information for the host
8 properties 8 required
TaskMO
object
A task that was created as a result of an operation performed on the system
7 properties 5 required
physical_drive
object
The physical drive
15 properties 14 required
ShutdownResponseMO
object
1 property 1 required
drive_set
object
The drive set information
8 properties 8 required
storage_adapter
object
The storage adapter information for the host
7 properties 7 required
accelerator_card
object
The accelerator card information for the host
5 properties 5 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

simplivity-hosts-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 omnistack_clusters 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 hosts 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.