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

A virtual_machine represents a single virtual machine created within an HPE SimpliVity datastore.

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

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

This API exposes 14 operations across 14 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.

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

Paths & Operations 14

Across 14 paths, the API surfaces 14 operations — 4 GET, 10 POST. Each is listed below with its method, path, parameters, and response codes.

virtual_machines 14

A virtualmachine represents a single virtual machine created within an HPE SimpliVity datastore.

GET
/virtual_machines
Retrieves instances of HPE SimpliVity virtual machines defined on this system
listVms 27 params → 200401403404
POST
/virtual_machines/policy_impact_report/apply_policy
Generate a backup impact reported based on proposed application of a policy to one or more virtual machines
reportOnProposedVMPolicySetting body → 200201401403404
POST
/virtual_machines/set_policy
Sets the backup policy for virtual machines
setPolicyForVms body → 200201401403404
GET
/virtual_machines/{vmId}
Retrieves the specified virtualmachines
getVm 1 param → 200401403404
POST
/virtual_machines/{vmId}/backup
Backs up a virtual machine
backupVm 1 param body → 200201401403404
POST
/virtual_machines/{vmId}/backup_parameters
Set the virtual machine backup parameters used for application consistent backups.
setBackupParams 1 param body → 200201401403404
GET
/virtual_machines/{vmId}/backupsdeprecated
Retrieves all backups associated with this virtualmachine
listVMBackups 1 param → 200401403404
POST
/virtual_machines/{vmId}/clone
Clones a virtual machine
cloneVm 1 param body → 200201401403404
GET
/virtual_machines/{vmId}/metrics
Retrieves throughput, IOPS, and latency data for the virtual machine
getVmMetrics 4 params → 200401403404
POST
/virtual_machines/{vmId}/move
Moves a virtual machine to another datastore
moveVm 1 param body → 200201401403404
POST
/virtual_machines/{vmId}/power_off
Power off a VM
powerOffVMUsingPOST 1 param → 200201401403404
POST
/virtual_machines/{vmId}/power_on
Power on a VM
powerOnVMUsingPOST 1 param → 200201401403404
POST
/virtual_machines/{vmId}/set_policy
Sets the backup policy for a virtual machine
setPolicyForVm 1 param body → 200201401403404
POST
/virtual_machines/{vmId}/validate_backup_credentials
Validates the credentials for the virtual machine you want to backup
validateBackupCred 1 param body → 200201401403404

Schemas 18

The contract defines 18 schemas that model the data the API accepts and returns. The most detailed are virtual_machine (39 properties), BackupMO (29 properties), TaskMO (7 properties), policy_schedule_report (6 properties). Each schema is shown below with its type and property counts.

analytics_info
object
The metrics information
2 properties 2 required
move_virtual_machine
object
Moves a virtual machine to another datastore
2 properties 1 required
policy_schedule_impact_report
object
The policy backup schedule reports for prior to and after applying proposed changes
2 properties 2 required
vm_set_policy_vms
object
Sets the backup policy for virtual machines
2 properties 2 required
NetworkInterface
object
6 properties 6 required
BackupVMMO
object
6 properties 1 required
validate_backup_credentials
object
Validates the credentials for the virtual machine you want to backup
2 properties 2 required
ReplicaInfo
object
2 properties 2 required
credentials_validation
object
Status of the virtual machine credentials validation operation
1 property 1 required
backup_parameters
object
Set the virtual machine backup parameters used for application consistent backups.
4 properties
set_policy
object
Sets the backup policy for a virtualmachine or datastore
1 property 1 required
AffectedObjectMO
object
2 properties 2 required
MetricsDataMO
object
3 properties 3 required
CloneVMMO
object
3 properties 1 required
TaskMO
object
A task that was created as a result of an operation performed on the system
7 properties 5 required
policy_schedule_report
object
A policy on this system
6 properties 6 required
BackupMO
object
29 properties 28 required
virtual_machine
object
An instance of a virtualmachine defined on this system
39 properties 21 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

simplivity-virtual-machines-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 omnistack_clusters API
SimpliVity policies API
SimpliVity security API
SimpliVity tasks API
Where this information came from

This is an independent, third-party profile of SimpliVity virtual_machines 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.