# SimpliVity virtual_machines API

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

SimpliVity virtual_machines 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. Tagged areas include Virtual Machines. The published artifact set on APIs.io includes an OpenAPI specification and authentication docs.

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

## Operations (14)

| Method | Path | Summary |
|---|---|---|
| GET | `/virtual_machines` | Retrieves instances of HPE SimpliVity virtual machines defined on this system |
| 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 |
| POST | `/virtual_machines/set_policy` | Sets the backup policy for virtual machines |
| GET | `/virtual_machines/{vmId}` | Retrieves the specified virtual_machines |
| POST | `/virtual_machines/{vmId}/backup` | Backs up a virtual machine |
| POST | `/virtual_machines/{vmId}/backup_parameters` | Set the virtual machine backup parameters used for application consistent backups. |
| GET | `/virtual_machines/{vmId}/backups` | Retrieves all backups associated with this virtual_machine |
| POST | `/virtual_machines/{vmId}/clone` | Clones a virtual machine |
| GET | `/virtual_machines/{vmId}/metrics` | Retrieves throughput, IOPS, and latency data for the virtual machine |
| POST | `/virtual_machines/{vmId}/move` | Moves a virtual machine to another datastore |
| POST | `/virtual_machines/{vmId}/power_off` | Power off a VM |
| POST | `/virtual_machines/{vmId}/power_on` | Power on a VM |
| POST | `/virtual_machines/{vmId}/set_policy` | Sets the backup policy for a virtual machine |
| POST | `/virtual_machines/{vmId}/validate_backup_credentials` | Validates the credentials for the virtual machine you want to backup |

## Machine-readable artifacts (3)

- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/simplivity/refs/heads/main/openapi/simplivity-virtual-machines-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 omnistack_clusters API](https://apis.io/apis/simplivity/simplivity-omnistack-clusters-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/)

## Tags

Virtual Machines

---

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