Skip to content
Internal API Catalog
/
Backup and Recovery API
/
API reference
/
v1beta1
/
virtual-machine-protection-groups
/
Get information about all virtual machine protection groups backups.

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

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"
  }
}

Get information about all virtual machine protection groups backups.

Request

Get information about all Virtual Machine protection group backups.

Security
bearer
Path
vmpg-idstringread-onlyrequired

UUID string uniquely identifying the Virtual Machine Protection Group.

Example: 9b4c14a6-3cd5-4907-97c4-cf44c5b641e4
Query
offsetinteger

The number of items to skip before starting to collect the result set.

limitinteger[ 1 .. 1000 ]
Default 20
filterstring

The filter query parameter is used to filter the set of resources returned in the response. The returned set of resources must match the criteria in the filter query parameter.

A comparision compares a property name to a literal. The comparisons supported are the following:

  • “eq” : Is a property equal to value. Valid for number, boolean and string properties.
  • “gt” : Is a property greater than a value. Valid for number or string timestamp properties.
  • “lt” : Is a property less than a value. Valid for number or string timestamp properties.
  • “in” : Is a value in a property (that is an array of strings).

Filters are supported on following attributes:

  • backupType
  • state
  • status
  • createdByInfo/id
  • createdByInfo/name
  • sourceCopyInfo/id
  • pointInTime
  • verified
  • storageSystemInfo/id
  • storageSystemInfo/name
  • protectionStoreInfo/id
  • protectionStoreInfo/name
  • dataOrchestratorInfo/id
  • expiresAt
  • name Examples:
  • GET /backup-recovery/v1beta1/virtual-machine-protection-groups/{vmpg-id}/backups?filter=backupType eq 'CLOUD_BACKUP'
sortstring

A comma separated list of properties to sort by, followed by a direction indicator ("asc" or "desc"). If no direction indicator is specified, the default order is ascending.

selectstring

The select query parameter is used to limit the properties returned with a resource or collection-level GET. Multiple properties can be listed to be returned. The server must only return the set of properties requested by the client. The property “select” is the name of the select query parameter; its value is the list of properties to return separated by commas.

curl -i -X GET \
  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/backups \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

virtual-machine-protection-group backup list

Bodyapplication/json
countintegerrequired

The number of resources in the items array.

itemsArray of objects(VmpgBackup)required
items[].​idstringread-onlyrequired

UUID string uniquely identifying the Virtual Machine Protection Group backup.

Example: "9b4c14a6-3cd5-4907-97c4-cf44c5b641e4"
items[].​typestringread-onlyrequired

The type of resource

Example: "backup-recovery/virtual-machine-protection-group-backup"
items[].​appTypestring

Type of the application to which the backup belongs.

Value"VMWARE"
items[].​backupSetsInfoArray of objects

Information about the associated backupSetInfo. This is an array to handle application backups spanning multiple objects in the device.

items[].​backupTypestring
Enum"BACKUP""CLOUD_BACKUP"
items[].​consistencystring(Consistency)

Specifies whether to create crash consistent or application consistent snapshot. CrashConsistentOnFailure: If an application consistent snapshot fails for any reason, with this option it will then take a crash consistent snapshot and continue.

Enum"CRASH""APPLICATION""CRASH_CONSISTENT_ON_FAILURE"
items[].​consoleUristring(ConsoleUri)read-only

The URI for console screen that displays this object.

items[].​containsRdmDisksboolean

Indicates if the recovery point has RDM disk or not

items[].​createdAtstring(date-time)read-only

Time in UTC at which the object was created.

items[].​createdByInfoobject

Information about the user who initiated the workflow that created this backup.

items[].​customerIdstringread-only

The customer application identifier

items[].​dataOrchestratorInfoArray of objects
items[].​descriptionstring

Brief description about the application backup.

items[].​expiresAtstring(date-time)

Absolute value of time in UTC at which the application.

items[].​generationinteger(int64)read-only

A monotonically increasing value. This value updates when the resource is updated and can be used as a short way to determine if a resource has changed or which of two different copies of a resource is more up to date.

items[].​lockedUntilstring(date-time)

Absolute value of time in UTC until which the application backup is locked.

Example: "2020-04-03T05:03:08.900Z"
items[].​namestring<= 255 charactersread-only

A user-friendly name to identify Virtual Machine Protection Group backup.

Example: "backup1"
items[].​pointInTimestring(date-time)

Time in UTC at which the application backup was created on the device.

Example: "2020-03-03T05:03:08.902Z"
items[].​protectionStoreInfoobject(CopyPoolInfo)

Information about the protection store where the copy is created.

items[].​resourceUristring(uri)read-only

The 'self' reference for this resource.

Example: "/backup-recovery/v1beta1/virtual-machine-protection-groups/{id}/backups/id/"
items[].​scheduleInfoobject

Details about the schedule which created this snapshot.

items[].​sourceCopyInfoobject
items[].​statestring

The current state of the application backup.

Enum"OK""ERROR""CREATING"
items[].​stateReasonstring<= 255 characters

Brief reason for the current state of the application backup.

items[].​statusstring

Current status of the application backup.

Enum"OK""ERROR""WARNING"
items[].​storageSystemInfoobject

Information about storage system where backup is created.

items[].​updatedAtstring(date-time)read-only

Time in UTC at which the object was last updated.

items[].​verificationInfoobject

Backup verification status details. Block level verification of backup with snapshot.

items[].​verifiedboolean

Flag indicating whether backup-set was verified or not

offsetintegerrequired

The offset specified in the offset query parameter.

totalinteger

The total count of objects in the result set.

Response
application/json
{
  "count": 0,
  "items": [
    { … }
  ],
  "offset": 0,
  "total": 0
}

Delete a virtual machine protection group backup.

Request

Remove a virtual machine protection group backup.

Security
bearer
Path
vmpg-idstringread-onlyrequired

UUID string uniquely identifying the Virtual Machine Protection Group.

Example: 9b4c14a6-3cd5-4907-97c4-cf44c5b641e4
backup-idstringread-onlyrequired

UUID string uniquely identifying the Virtual Machine Protection Group backup.

Example: 9b4c14a6-3cd5-4907-97c4-cf44c5b641e4
curl -i -X DELETE \
  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/backups/9b4c14a6-3cd5-4907-97c4-cf44c5b641e4 \
  -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
{}

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