Skip to content
Internal API Catalog
/
Backup and Recovery API
/
API reference
/
v1beta1
/
virtual-machine-protection-groups

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 all virtual machine Protection Groups.

Request

List all virtual machine Protection Groups.

Security
bearer
Query
offsetinteger

The number of items to omit from the beginning of the result set. The offset and limit query parameters are used in conjunction with pagination. For example "offset=30&limit=10" indicates the fourth page of 10 items.

limitinteger[ 1 .. 1000 ]

The maximum number of items to include in the response. The offset and limit query parameters are used in conjunction for pagination, for example "offset=30&limit=10" indicates the fourth page of 10 items.

Default 20
filterstring

An expression by which to filter the results.

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

  • “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). example: vmProtectionGroupType eq 'NATIVE'

Filters are supported on the following attributes:

  • hypervisorManagerInfo/name
  • hypervisorManagerInfo/id
  • vmProtectionGroupType
  • dataOrchestratorInfo/id
  • createdAt
  • name
sortstring

Comma separated list of properties defining the sort order. Each item in the “sort” query parameter is a property name optionally followed by a direction indicator. The direction indicator may only be either “asc” (ascending) or “desc” (descending). 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 formatted as an exclusive comma separated list of properties. If not specified, all properties are returned.

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 \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Success

Bodyapplication/json
countintegerrequired

The number of resources in the items array.

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

UUID string uniquely identifying the Virtual Machine Protection Group.

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

The type of resource.

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

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

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

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

items[].​assetsCategorystring

The type of the protected assets.

Enum"VVOL_VMS""VMFS_DATASTORES""VMFS_VMS"
items[].​consoleUristring(ConsoleUri)read-only

The URI for console screen that displays this object.

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

Time in UTC at which the object was created.

items[].​customerIdstringread-only

The customer application identifier

items[].​dataOrchestratorInfoArray of objects
items[].​descriptionstring<= 255 characters

A brief description of the Protection Group.

items[].​displayNamestring

User-defined name given to the Protection Group.

Example: "myProtectionGroup"
items[].​dynamicMemberFilterobject
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[].​hypervisorManagerInfoobject
items[].​namestring<= 255 characters

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

Example: "myProtectionGroup"
items[].​nativeAppInfoobject
items[].​protectedResourcesInfoobject
items[].​protectionJobInfoobject(DataManagementJobInfo)

Information about the assigned Protection Policy and the Protection Job.

items[].​replicationInfoobject(ReplicationInfo)

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

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

The 'self' reference for this resource.

Example: "/backup-recovery/v1beta1/virtual-machine-protection-groups/id/"
items[].​statestring

Current state of the group.

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

Brief reason for the current state of the group.

items[].​statusstring

Current status of the group.

Enum"OK""ERROR""WARNING"
items[].​updatedAtstring(date-time)read-only

Time in UTC at which the object was last updated.

items[].​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"
items[].​volumesInfoArray of objects(VolumeInfo)

List of Volumes associated with vm protection group.

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
}

Create a new virtual machine Protection Group.

Request

Create the virtual machine Protection Group for data management.

Security
bearer
Bodyapplication/jsonrequired
namestring<= 255 charactersrequired

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

vmProtectionGroupTypestringrequired

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

The type of the protected assets.

Enum"VVOL_VMS""VMFS_DATASTORES""VMFS_VMS"
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
nativeAppInfoobject
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 \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "assetsCategory": "VVOL_VMS",
    "name": "myProtectionGroup",
    "vmProtectionGroupType": "NATIVE"
  }'

Responses

Accepted

Headers
Locationstring

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

Bodyapplication/json
object
Response
application/json
{}

Remove a virtual machine Protection Group.

Request

Remove 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
Query
cascadedeleteboolean

Cascade delete option for Virtual Machine Protection Group of type Storage Replication.

Default false
Example: cascadedelete=true
forceboolean

Forceful delete option for Virtual Machine Protection Group of type Storage Replication.

Default false
Example: force=true
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 \
  -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