Skip to content
Internal API Catalog
/
Backup and Recovery API
/
virtual-machines

Backup and Recovery API (1.1.0)

Backup and Recovery API

Download OpenAPI description
index.json
index.yaml
Overview
License

HPE End User License Agreement

Languages
Servers
Mock server

https://stage-developer-portal-hpe.redocly.app/_mock/docs/greenlake/services/backup-recovery/public/openapi/backup-recovery-public-v1beta1/

https://us-west.api.greenlake.hpe.com/

https://eu-west.api.greenlake.hpe.com/

https://eu-central.api.greenlake.hpe.com/

https://ap-northeast.api.greenlake.hpe.com/

Protection Store Gateway

Protection Store Gateway APIs

Operations

StoreOnce

StoreOnce APIs

Operations

application-hosts

The Application Hosts API allows the registration and management of Application Hosts.

Operations

data-orchestrators

APIs for managing Data Orchestrator operations.

Operations

datastores

The datastores API allows the data management operations on datastores.

Operations

mssql-database-backups

The MSSQL database backups API allows the creation and management of MSSQL database backups.

Operations

mssql-database-protection-groups

The MSSQL database Protection Groups API allows management of MSSQL database Protection Groups.

Operations

mssql-database-snapshots

The MSSQL database snapshots API allows the creation and management of MSSQL database snapshots.

Operations

mssql-databases

The MSSQL Databases API allows management of MSSQL databases.

Operations

mssql-instances

The MSSQL Instances API allows management of MSSQL instances.

Operations

protection-jobs

The Protection Jobs API allows the creation and management of Protection Jobs.

Operations

protection-policies

The Protection Policies API allows the creation and management of Protection Policies.

Operations

protection-stores

This API allows the creation and management of Protection Stores that represents the backup target for the copies.

Operations

virtual-machine-protection-groups

The virtual machine Protection Groups API allows the creation and management of virtual machine Protection Groups (Group of Virtual Machines, Datastores or Folder for Protection).

Operations

virtual-machines

The virtual machines API allows the data management operations on virtual machines.

Operations

Restore a virtual machine from snapshot or backup.

Request

Restores a virtual machine from the selected snapshot or backup.

Security
bearer
Path
idstringrequired

UUID string uniquely identifying the virtual machine

Example: 9b4c14a6-3cd5-4907-97c4-cf44c5b641e4
Bodyapplication/jsonrequired
restoreTypestringrequired

Specifies the type of restore that needs to be performed.

Enum"PARENT""ALTERNATE"
snapshotIdstringrequired

UUID string uniquely identifying the snapshot. Mandatory if the restore is from a snapshot.

Example: "9b4c14a6-3cd5-4907-97c4-cf44c5b641e4"
backupIdstringrequired

UUID string uniquely identifying the backup. Mandatory if the restore is from a backup.

Example: "9b4c14a6-3cd5-4907-97c4-cf44c5b641e4"
targetVmInfoobject

Provides the details about the target VM location, compute, etc These inputs are required only if the restore type is 'ALTERNATE'.

curl -i -X POST \
  https://stage-developer-portal-hpe.redocly.app/_mock/docs/greenlake/services/backup-recovery/public/openapi/backup-recovery-public-v1beta1/backup-recovery/v1beta1/virtual-machines/9b4c14a6-3cd5-4907-97c4-cf44c5b641e4/restore \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "backupId": "9b4c14a6-3cd5-4907-97c4-cf44c5b641e4",
    "restoreType": "PARENT",
    "snapshotId": "9b4c14a6-3cd5-4907-97c4-cf44c5b641e4"
  }'

Responses

Accepted

Headers
Locationstring
Bodyapplication/json
object
Response
application/json
{}

Restore one or more disks of a virtual machine from snapshot or backup.

Request

Restore one or more disks of a virtual machine.

Security
bearer
Path
idstringrequired

UUID string uniquely identifying the virtual machine

Example: 9b4c14a6-3cd5-4907-97c4-cf44c5b641e4
Bodyapplication/jsonrequired
snapshotIdstringrequired

UUID string uniquely identifying the snapshot. Mandatory if the restore if from snapshot.

Example: "9b4c14a6-3cd5-4907-97c4-cf44c5b641e4"
restoreTypestringrequired

Specifies the type of restore that needs to be performed.

Enum"PARENT""ALTERNATE"
backupIdstringrequired

UUID string uniquely identifying the backup. Mandatory if the restore is from a backup.

Example: "9b4c14a6-3cd5-4907-97c4-cf44c5b641e4"
restoreDiskDetailsArray of objects
targetVmIdstring

Identifier of the target VM where disks needs to be restored to. This is optional. By default restores are performed to the original VM. This provides an option to the user to restore disks to a different VM. This identifier can not be a id of deleted VM.

curl -i -X POST \
  https://stage-developer-portal-hpe.redocly.app/_mock/docs/greenlake/services/backup-recovery/public/openapi/backup-recovery-public-v1beta1/backup-recovery/v1beta1/virtual-machines/9b4c14a6-3cd5-4907-97c4-cf44c5b641e4/restore-disks \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "backupId": "9b4c14a6-3cd5-4907-97c4-cf44c5b641e4",
    "restoreType": "PARENT",
    "snapshotId": "9b4c14a6-3cd5-4907-97c4-cf44c5b641e4"
  }'

Responses

Accepted

Headers
Locationstring
Bodyapplication/json
object
Response
application/json
{}

Restore files and folders of a virtual machine.

Request

Restore one or more files and folders of a virtual machine from snapshot or backup.

Security
bearer
Path
idstringrequired

UUID string uniquely identifying the virtual machine

Example: 9b4c14a6-3cd5-4907-97c4-cf44c5b641e4
Bodyapplication/jsonrequired
One of:

Definition for the request body for restoring virtual machine files and folders from a snapshot.

snapshotIdstringrequired

UUID string uniquely identifying the snapshot. Mandatory if the restore is from a snapshot.

Example: "9b4c14a6-3cd5-4907-97c4-cf44c5b641e4"
fileRestoreMethodstringrequired

Specifies the action if the destination already contains a file or folder with the same name.
OVERWRITE - Existing files/folders will be replaced with the restored files/folders from the copy.
KEEPASBACKUP - The restored files/folders will be maintained as a copy on the destination with timestamp appended to their names.
SKIP - The files/folders will be skipped during restore.

Enum"OVERWRITE""KEEPASBACKUP""SKIP"
filePathInfoArray of objectsrequired

Specifies absolute path of selected files or folders and target destination.

filePathInfo[].​absoluteSourcePathstring

Absolute path of source files and folders to be restored.

filePathInfo[].​absoluteTargetPathstring

Absolute path of the target destination.

targetInfoobjectrequired

Target system information onto which the files and folders are restored to.

targetInfo.​credentialsInfoobject

User credentials to the target VM. Given credentials must have write permissions on the given target path.

targetInfo.​virtualMachineIdstring

UUID string uniquely identifying the virtual machine.

Example: "9b4c14a6-3cd5-4907-97c4-cf44c5b641e5"
retainOriginalDirectoryStructureboolean

Specifies if restore preserves the source directory structure at the destination when restoring a file or folder.

curl -i -X POST \
  https://stage-developer-portal-hpe.redocly.app/_mock/docs/greenlake/services/backup-recovery/public/openapi/backup-recovery-public-v1beta1/backup-recovery/v1beta1/virtual-machines/9b4c14a6-3cd5-4907-97c4-cf44c5b641e4/restore-files \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "filePathInfo": [
      {}
    ],
    "fileRestoreMethod": "OVERWRITE",
    "snapshotId": "9b4c14a6-3cd5-4907-97c4-cf44c5b641e4",
    "targetInfo": {}
  }'

Responses

Accepted

Headers
Locationstring
Bodyapplication/json
object
Response
application/json
{}

volume-protection-groups

The Volume Protection Groups API allows the creation and management of Volume Protection Groups (Group of Volumes for Protection).

Operations

datastore-backups

Operations

datastore-snapshots

Operations

virtual-machine-backups

Operations

virtual-machine-snapshots

Operations

volume-protection-group-backups

Operations

volume-protection-group-snapshots

Operations