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

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

Get a virtual machine Protection Group resource.

Request

Get detailed information for a registered virtual machine Protection Group qualified by id.

Security
bearer
Path
idstringread-onlyrequired

UUID string uniquely identifying the Virtual Machine Protection Group.

Example: 9b4c14a6-3cd5-4907-97c4-cf44c5b641e4
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 \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Success

Bodyapplication/json
idstringread-onlyrequired

UUID string uniquely identifying the Virtual Machine Protection Group.

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

The type of resource.

Example: "backup-recovery/virtual-machine-protection-group"
appTypestring

Type of the application to which the vm-protection-group belongs.

Value"VMWARE"
assetsArray of objects

Captures the list of assets that would be part of the protection group.

assetsCategorystring

The type of the protected assets.

Enum"VVOL_VMS""VMFS_DATASTORES""VMFS_VMS"
consoleUristring(ConsoleUri)read-only

The URI for console screen that displays this object.

createdAtstring(date-time)read-only

Time in UTC at which the object was created.

customerIdstringread-only

The customer application identifier

dataOrchestratorInfoArray of objects
descriptionstring<= 255 characters

A brief description of the Protection Group.

displayNamestring

User-defined name given to the Protection Group.

Example: "myProtectionGroup"
dynamicMemberFilterobject
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.

hypervisorManagerInfoobject
namestring<= 255 characters

A user-friendly name to identify Virtual Machine protection group.

Example: "myProtectionGroup"
nativeAppInfoobject
protectedResourcesInfoobject
protectionJobInfoobject(DataManagementJobInfo)

Information about the assigned Protection Policy and the Protection Job.

replicationInfoobject(ReplicationInfo)

Replication groups information containing details of all replication partners. Applicable only for Protection Group type 'STORAGE_REPLICATION_GROUP'

resourceUristring(uri)read-only

The 'self' reference for this resource.

Example: "/backup-recovery/v1beta1/virtual-machine-protection-groups/id/"
statestring

Current state of the group.

Enum"OK""ERROR""CREATING"
stateReasonstring<= 255 characters

Brief reason for the current state of the group.

statusstring

Current status of the group.

Enum"OK""ERROR""WARNING"
updatedAtstring(date-time)read-only

Time in UTC at which the object was last updated.

vmProtectionGroupTypestring

The type of the Protection Group. This can be Native for storage system specific constructs like StorageReplicationGroup or application specific constructs such as VMware Folder or vVol container. Custom if its just a collection of assets (Virtual Machine, Datastores etc).

Enum"NATIVE""CUSTOM""DYNAMIC"
volumesInfoArray of objects(VolumeInfo)

List of Volumes associated with vm protection group.

Response
application/json
{
  "appType": "VMWARE",
  "assets": [
    { … }
  ],
  "assetsCategory": "VVOL_VMS",
  "consoleUri": "string",
  "createdAt": "2019-08-24T14:15:22Z",
  "customerId": "string",
  "dataOrchestratorInfo": [
    { … }
  ],
  "description": "string",
  "displayName": "myProtectionGroup",
  "dynamicMemberFilter": {
    "members": [ … ],
    "type": "virtualization/hypervisor-tag"
  },
  "generation": 0,
  "hypervisorManagerInfo": {
    "id": "9b4c14a6-3cd5-4907-97c4-cf44c5b641e4",
    "name": "vcenter123.hpe.com",
    "resourceUri": "/virtualization/v1beta1/hypervisor-managers/id/",
    "type": "virtualization/hypervisor-manager"
  },
  "id": "9b4c14a6-3cd5-4907-97c4-cf44c5b641e4",
  "name": "myProtectionGroup",
  "nativeAppInfo": {
    "id": "9b4c14a6-3cd5-4907-97c4-cf44c5b641e4",
    "name": "myVmFolder",
    "type": "VMWARE_FOLDER"
  },
  "protectedResourcesInfo": {
    "virtualMachinesCount": 5
  },
  "protectionJobInfo": {
    "id": "c9cdeb6b-24cb-43c1-828a-e8b1b050f3f4",
    "name": "string",
    "protectionPolicyInfo": { … },
    "resourceUri": "string",
    "type": "string"
  },
  "replicationInfo": {
    "id": "string",
    "name": "string",
    "partnerDetails": [ … ],
    "resourceUri": "/storage-fleet/v1/storage-systems/{uuid}/volume-sets",
    "type": "storage-fleet/volume-set"
  },
  "resourceUri": "/backup-recovery/v1beta1/virtual-machine-protection-groups/id/",
  "state": "OK",
  "stateReason": "string",
  "status": "OK",
  "type": "backup-recovery/virtual-machine-protection-group",
  "updatedAt": "2019-08-24T14:15:22Z",
  "vmProtectionGroupType": "NATIVE",
  "volumesInfo": [
    { … }
  ]
}

Update a virtual machine Protection Group.

Request

Update attributes for 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
Bodyapplication/merge-patch+jsonrequired
assetsArray of objects

Captures the list of assets that would be part of the protection group.

descriptionstring<= 255 characters

A brief description of the Protection Group.

dynamicMemberFilterobject
namestring<= 255 characters

A user-friendly name to identify Virtual Machine protection group.

curl -i -X PATCH \
  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 \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/merge-patch+json' \
  -d '{}'

Responses

Accepted

Headers
Locationstring

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

Bodyapplication/json
object
Response
application/json
{}

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

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