Skip to content
Internal API Catalog
/
Backup and Recovery API
/
API reference
/
v1beta1
/
virtual-machine-protection-groups
/
Restore a virtual machine Protection Group from recovery points.

Backup and Recovery API (1.1.0)

Backup and Recovery API

Download OpenAPI description
backup-recovery-api.json
backup-recovery-api.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/backup-recovery-api/

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

Refresh a virtual machine Protection Group.

Request

Refresh a virtual machine Protection Group.

Security
bearer
Path
idstringread-onlyrequired

UUID string uniquely identifying the Virtual Machine Protection Group.

Example: 9b4c14a6-3cd5-4907-97c4-cf44c5b641e4
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-api/backup-recovery/v1beta1/virtual-machine-protection-groups/9b4c14a6-3cd5-4907-97c4-cf44c5b641e4/refresh \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Accepted

Headers
Locationstring

This contains the URI of the task used to monitor the request.

Bodyapplication/json
object
Response
application/json
{}

Restore a virtual machine Protection Group from recovery points.

Request

Restore a virtual machine Protection Group from recovery points.

Security
bearer
Path
idstringread-onlyrequired

UUID string uniquely identifying the Virtual Machine Protection Group.

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

A brief description about the new VM.

namePostfixstring

A postfix name given by user for the new VM.

namePrefixstring

A prefix name for the new VM.

powerOnVmsAfterRestoreboolean

True if all the resources in the Virtual Machine Protection Group needs to be poweredon after restore. Required only in case of alternate datastore restore.

recoveryInfoArray of objects

Recovery point information.

restoreAllResourcesboolean

True if all the resources in the Virtual Machine Protection Group needs to be restored.

restoreTypestring

Specifies the type of restore needs to be performed.

Enum"PARENT""ALTERNATE"
targetInfoobject

Provides the details about 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-api/backup-recovery/v1beta1/virtual-machine-protection-groups/9b4c14a6-3cd5-4907-97c4-cf44c5b641e4/restore \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{}'

Responses

Accepted

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

Restore pre-check of a virtual machine Protection Group from recovery points.

Request

Validations and recovery point info of a virtual machine Protection Group.

Security
bearer
Path
idstringread-onlyrequired

UUID string uniquely identifying the Virtual Machine Protection Group.

Example: 9b4c14a6-3cd5-4907-97c4-cf44c5b641e4
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-api/backup-recovery/v1beta1/virtual-machine-protection-groups/9b4c14a6-3cd5-4907-97c4-cf44c5b641e4/restore-pre-check \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Success

Bodyapplication/json
resourceSummaryobject

Summary for dry run at individual resource level.

summaryobject

Summary of the dry run at Protection Group level.

Response
application/json
{
  "resourceSummary": {
    "resourceInfo": [ … ]
  },
  "summary": {
    "error": "string",
    "status": "OK"
  }
}

virtual-machines

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

Operations

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