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

A backup is a complete, standalone image of a specific virtual machine, taken at a specific point in time.

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

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

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

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

Paths & Operations 15

Across 14 paths, the API surfaces 15 operations — 1 DELETE, 5 GET, 9 POST. Each is listed below with its method, path, parameters, and response codes.

backups 15

A backup is a complete, standalone image of a specific virtual machine, taken at a specific point in time.

GET
/backups
Retrieves all backups defined on this system
listBackups 40 params → 200401403404
POST
/backups/delete
Deletes the specified list of backup instances
deleteBackups body → 200201401403404
POST
/backups/set_retention
Sets the retention time for the specified list of backups
setBackupRetention body → 200201202401403404
GET
/backups/{bkpId}
Retrieves the specified backup
getBackup 1 param → 200401403404
DELETE
/backups/{bkpId}
Deletes the specified backup
deleteBackup 1 param → 200204401403
POST
/backups/{bkpId}/calculate_unique_size
Calculates the unique size of the specified backup
calculateUniqueSize 1 param → 200201401403404
POST
/backups/{bkpId}/cancel
Cancels the specified running backup
cancelBackup 1 param → 200201401403404
POST
/backups/{bkpId}/copy
Copies the specified backup to another omnistackcluster or externalstore
copyBackup 1 param body → 200201401403404
POST
/backups/{bkpId}/lock
Saves the specified backup to prevent it from expiring
lockBackup 1 param → 200201401403404
POST
/backups/{bkpId}/rename
Renames the specified backup
renameBackup 1 param body → 200201401403404
POST
/backups/{bkpId}/restore
Creates a new virtual machine or replaces the original virtual machine from the specified backup
restoreFromBackup 2 params body → 200201401403404
POST
/backups/{bkpId}/restore_files
Restore files from a specific partition
restoreFiles 1 param body → 200201401403404
GET
/backups/{bkpId}/virtual_disk_partition_files
Retrieves the virtual hard disk files from the backup
getBackupFiles 4 params → 200401403404
GET
/backups/{bkpId}/virtual_disk_partitions
Retrieves partition information for the virtual disk associated with the backup
getBackupPartitions 2 params → 200401403404
GET
/backups/{bkpId}/virtual_disks
Retrieves the virtual hard disk files from the backup
getVirtualDisksFromBackup 1 param → 200401403404

Schemas 12

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

BackupPartitionDataMO
object
4 properties 4 required
BackupVirtualDiskMO
object
1 property 1 required
restore_file
object
Restore files from a specific partition
2 properties 2 required
AffectedObjectMO
object
2 properties 2 required
backup_copy
object
Copies the specified backup to another omnistackcluster or externalstore
2 properties 2 required
backup_retention_set
object
Sets the retention time for the specified list of backups
4 properties 2 required
TaskMO
object
A task that was created as a result of an operation performed on the system
7 properties 5 required
BackupFileDataMO
object
6 properties 6 required
delete_backups
object
Deletes the specified list of backup instances
2 properties 1 required
restore_virtual_machine
object
Creates a new virtual machine or replaces the original virtual machine from the specified backup
2 properties 1 required
rename_backup
object
Renames the specified backup
1 property 1 required
BackupMO
object
29 properties 28 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

simplivity-backups-api-openapi.yml Raw ↑

Other APIs SimpliVity publishes across the network.

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
SimpliVity virtual_machines API
Where this information came from

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